3. Modelo de dados¶
3.1. Objetos, valores e tipos¶
Objetos são abstrações do Python para dados. Todo dados em um programa Python, é representados por objetos ou por relações entre objetos.(De certo modo, e em conformidade com o modelo de Von Neumann em “stored program computer,” código também é representado por objetos.)
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 ‘: keyword: is’ compara as identidades de dois objetos; a função id()
retorna um inteiro representando sua identidade.
CPython implementation detail: Para CPython, id(x)
é o endereço de memória em que x
é armazenado.
O tipo de um objeto determina as operações que o objeto suporta (por exemplo, “ele tem um comprimento?”) e também define os valores possíveis para objetos desse tipo. A função type()
retorna o tipo de um objeto (que é o próprio objeto). Como sua identidade, o objeto: dfn: type também é imutável. [#] _
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 uma coleção que contém uma referência a um objeto mutável pode mudar quando o valor deste último for mudado; no entanto a coleção é 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.
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 qualidade de implementação como a coleta de lixo é implementada, desde que nenhum objeto seja coletado que ainda esteja acessível.
CPython implementation detail: CPython atualmente usa um esquema de contagem de referência 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 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 (portanto, 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 “try
…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 close()
. Os programas são fortemente recomendados para fechar explicitamente esses objetos. A instrução “try
…finally
” e a instrução “with
” fornecem maneiras convenientes de fazer isso.
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 a = 1; b = 1
, a
e b
podem ou não se referir ao mesmo objeto com o valor um, dependendo da implementação, mas após c = []; d = []
, c
e d
têm a garantia de referir-se a duas listas vazias diferentes e únicas. (Observe que c = d = []
atribui o mesmo objeto para c
e d
.)
3.2. A hierarquia de tipos padrão¶
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.
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.
- None
Este tipo possui um único valor. Existe um único objeto com este valor. Este objeto é acessado através do nome embutido
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 de verdade é falso.- NotImplemented
This type has a single value. There is a single object with this value. This object is accessed through the built-in name
NotImplemented
. Numeric methods and rich comparison methods should return this value if they do not implement the operation for the operands provided. (The interpreter will then try the reflected operation, or some other fallback, depending on the operator.) Its truth value is true.Veja a documentação Implementando as operações aritméticas para mais detalhes.;
- Ellipsis
Este tipo possui um único valor. Existe um único objeto com este valor. Este objeto é acessado através do literal
...
ou do nome embutidoEllipsis
(reticências). Seu valor de verdade é true.numbers.Number
Eles são criados por literais numéricos e retornados como resultados por operadores aritméticos e funções aritméticas integradas. 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.
Python distingue entre inteiros, números de ponto flutuante e números complexos:
numbers.Integral
Estes representam elementos do conjunto matemático de inteiros (positivos e negativos).
Existem dois tipos de inteiros:
Integers (
int
)Eles 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 é assumida 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.
- Booleans (
bool
) Estes representam os valores da verdade Falsos e Verdadeiros. Os dois objetos que representam os valores
False
eTrue
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"False"
ou"True"
são retornados, respectivamente.
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.
- Booleans (
numbers.Real
(float
)Eles 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.
numbers.Complex
(complex
)Eles 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
z
podem ser recuperadas através dos atributos somente leituraz.real
ez.imag
.
- Sequências
Eles representam conjuntos ordenados finitos indexados por números não negativos. A função embutida
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 pora[i]
.Sequências também suportam fatiamento:
a[i:j]
seleciona todos os itens com índice k de forma que i<=
k<
j. Quando usada como expressão, uma fatia é uma sequência do mesmo tipo. Isso implica que o conjunto de índices é renumerado para que comece em 0.Algumas sequências também suportam “fatiamento estendido” com um terceiro parâmetro de “etapa”:
a[i:j:k]
seleciona todos os itens de a com índice x ondex = i + n*k
, n>=
0
e i<=
x<
j.As sequências são distinguidas de acordo com sua mutabilidade:
- Sequências Imutáveis
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:
- Strings
Uma string é uma sequência de valores que representam pontos de código Unicode. Todos os pontos de código no intervalo
U+0000 - U+10FFFF
podem ser representados em uma string. Python não tem um tipochar
; em vez disso, cada ponto de código na string é representado como um objeto string com comprimento1
. A função embutidaord()
converte um ponto de código de sua forma de string para um inteiro no intervalo0 - 10FFFF
;chr()
converte um inteiro no intervalo0 - 10FFFF
para o comprimento correspondente do objeto de string1
.str.encode()
pode ser usado para converter umastr
parabytes
usando a codificação de texto fornecida, ebytes.decode()
pode ser usado para conseguir o oposto.- Tuplas
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.
- Bytes
Um objeto de 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
b'abc'
) e o construtor embutidobytes()
podem ser usado para criar objetos bytes. Além disso, os objetos bytes podem ser decodificados em strings através do métododecode()
.
- Sequências Mutáveis
As sequências mutáveis podem ser alteradas após serem criadas. As notações de assinatura e fatiamento podem ser usadas como o destino da atribuição e instruções
del
(delete, exclusão).Atualmente, existem dois tipos de sequência mutável intrínseca:
- Listas
Os itens de uma lista são objetos Python arbitrários. As listas são formadas colocando uma lista separada por vírgulas de expressões entre colchetes. (Observe que não há casos especiais necessários para formar listas de comprimento 0 ou 1.)
- Arrays de Bytes
Um objeto bytearray é um vetor mutável. Eles são criados pelo construtor embutido
bytearray()
. Além de serem mutáveis (e, portanto, inalteráveis), os vetores de bytes fornecem a mesma interface e funcionalidade que os objetos imutáveisbytes
.
O módulo de extensão
array
fornece um exemplo adicional de um tipo de sequência mutável, assim como o módulocollections
.
- Tipo Conjunto
Eles 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
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,
1
e1.0
), apenas um deles pode estar contido em um conjunto.Atualmente, existem dois tipos de conjuntos intrínsecos:
- Sets (conjuntos)
Eles representam um conjunto mutável. Eles são criados pelo construtor embutido
set()
e podem ser modificados posteriormente por vários métodos, comoadd()
.- Frozen sets
Eles representam um conjunto imutável. Eles são criados pelo construtor embutido
frozenset()
. Como um frozenset é imutável e hasheável, ele pode ser usado novamente como um elemento de outro conjunto, ou como uma chave de dicionário.
- Mappings
Eles representam conjuntos finitos de objetos indexados por conjuntos de índices arbitrários. A notação subscrito
a[k]
seleciona o item indexado pork
do mapeamentoa
; isso pode ser usado em expressões e como alvo de atribuições ou instruçõesdel
. A função embutidalen()
retorna o número de itens em um mapeamento.Atualmente, há um único tipo de mapeamento intrínseco:
- Dicionários
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,
1
e1.0
), eles podem ser usados alternadamente para indexar a mesma entrada do dicionário.Os dicionários são mutáveis; eles podem ser criados pela notação
{...}
(veja a seção Dictionary displays).Os módulos de extensão
dbm.ndbm
edbm.gnu
fornecem exemplos adicionais de tipos de mapeamento, assim como o módulocollections
.
- Tipo Callable
Estes são os tipos aos quais a operação de chamada de função (veja a seção Calls) pode ser aplicada:
- Funções Definidas pelo Usuário
Um objeto função definido pelo usuário será criado pela definição de função (veja a seção 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.
Atributos Especiais:
Atributo
Significado
__doc__
The function’s documentation string, or
None
if unavailable; not inherited by subclassesWritable
O nome da função
Writable
A função qualified name
Novo na versão 3.3.
Writable
__module__
O nome do módulo em que a função foi definida ou
None
se indisponível.Writable
__defaults__
A tuple containing default argument values for those arguments that have defaults, or
None
if no arguments have a default valueWritable
__code__
O objeto código que representa o corpo da função compilada.
Writable
__globals__
Uma referência ao dicionário que contém as variáveis globais da função — o espaço de nomes global do módulo no qual a função foi definida.
Somente Leitura
O espaço de nomes que oferece suporte a atributos de função arbitrários.
Writable
__closure__
None
or a tuple of cells that contain bindings for the function’s free variables.Somente Leitura
__annotations__
Um dicionário contendo anotações de parâmetros. As chaves do dict são os nomes dos parâmetros e
'return'
para a anotação de retorno, se fornecida.Writable
__kwdefaults__
Um dicionário contendo padrões para parâmetros somente-nomeados.
Writable
A maioria dos atributos rotulados como “Gravável” verifica o tipo do valor atribuído.
Os objetos de função também suportam a obtenção e configuraçã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 esses atributos. Observe que a implementação atual só oferece suporte a atributos de função em funções definidas pelo usuário. Atributos de função embutidas podem ser suportados no futuro.
Additional information about a function’s definition can be retrieved from its code object; see the description of internal types below.
- Instância de Métodos
Um objeto de 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).
Atributos especiais somente leitura:
__self__
é o objeto de instância da classe,__func__
é o objeto de função;__doc__
é a documentação do método (mesmo que__func__.__doc__
);__ name__
é o nome do método (mesmo que__func__.__name__
);__module__
é o nome do módulo no qual o método foi definido, ouNone
se indisponível.Os métodos também suportam o acesso (mas não a configuração) dos atributos arbitrários da função no objeto de função subjacente.
Os objetos de método definidos pelo usuário podem ser criados ao se obter um atributo de uma classe (talvez por meio de uma instância dessa classe), se esse atributo for um objeto de função definido pelo usuário ou um objeto de método de classe.
Quando um objeto de método de instância é criado recuperando um objeto de função definido pelo usuário de uma classe por meio de uma de suas instâncias, seu atributo
__self__
é a instância, e o objeto de método é considerado vinculado. O atributo__func__
do novo método é o objeto da função original.When a user-defined method object is created by retrieving another method object from a class or instance, the behaviour is the same as for a function object, except that the
__func__
attribute of the new instance is not the original method object but its__func__
attribute.Quando um objeto de método de instância é criado recuperando um objeto de método de classe de uma classe ou instância, seu atributo
__self__
é a própria classe, e seu atributo__func__
é o objeto de função subjacente ao método de classe.Quando um objeto de método de instância é chamado, a função subjacente (
__func__
) é chamada, inserindo a instância de classe (__self__
) na frente da lista de argumentos. Por exemplo, quandoC
é uma classe que contém uma definição para uma funçãof()
, ex
é uma instância deC
, chamandox.f(1)
é equivalente a chamarC.f(x, 1)
.Quando um objeto de método de instância é derivado de um objeto de método de classe, a “instância de classe” armazenada em
__self__
será na verdade a própria classe, de modo que chamarx.f(1)
ouC.f(1)
é equivalente a chamarf(C,1)
sendof
a função subjacente.Observe que a transformação de objeto de função em objeto de método de instância ocorre sempre que o atributo é recuperado da instância. Em alguns casos, uma otimização frutífera é atribuir o atributo a uma variável local e chamar essa variável local. Observe também que essa transformação ocorre apenas para funções definidas pelo usuário; outros objetos chamáveis (e todos os objetos não chamáveis) são recuperados sem transformação. Também é importante observar que as 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 apenas acontece quando a função é um atributo da classe.
- Funções Geradoras
A function or method which uses the
yield
statement (see section A declaração yield) is called a generator function. Such a function, when called, always returns an iterator object which can be used to execute the body of the function: calling the iterator’siterator.__next__()
method will cause the function to execute until it provides a value using theyield
statement. When the function executes areturn
statement or falls off the end, aStopIteration
exception is raised and the iterator will have reached the end of the set of values to be returned.- Coroutine functions
Uma função ou um método que é definida(o) usando
async def
é chamado de função de corrotina. Tal função, quando chamada, retorna um objeto de corrotina. Ele pode conter expressõesawait
, bem como instruçõesasync with
easync for
. Veja também a seção Objetos Coroutine.- Funções geradoras assíncronas
Uma função ou um método que é definida(o) usando
async def
e que usa a instruçãoyield
é chamada de função geradora assíncrona. Tal função, quando chamada, retorna um objeto iterador assíncrono que pode ser usado em uma instruçãoasync for
para executar o corpo da função.Chamar o método
aiterator.__anext__()
do iterador assíncrono retornará um aguardável que, quando aguardado, será executado até fornecer um valor usando a expressãoyield
. Quando a função executa uma instrução vaziareturn
ou cai no final, uma exceçãoStopAsyncIteration
é levantada e o iterador assíncrono terá alcançado o final do conjunto de valores a serem produzidos.- Funções Built-in
Um objeto função embutida é um wrapper em torno de uma função C. Exemplos de funções embutidas são
len()
emath.sin()
(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:__doc__
é a string de documentação da função, ouNone
se indisponível;__name__
é o nome da função;__self__
é definido comoNone
(mas veja o próximo item);__module__
é o nome do módulo no qual a função foi definida ouNone
se indisponível.- Métodos Built-in
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 é
alist.append()
, presumindo que alist é um objeto de lista. Nesse caso, o atributo especial de somente leitura__self__
é definido como o objeto denotado por alist.- 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
__new__()
. Os argumentos da chamada são passados para__new__()
e, no caso típico, para__init__()
para inicializar a nova instância.- Instância de Classe
Instâncias de classes arbitrárias podem ser tornados chamáveis definindo um método
__call__()
em sua classe.
- Módulos
Modules are a basic organizational unit of Python code, and are created by the import system as invoked either by the
import
statement (seeimport
), or by calling functions such asimportlib.import_module()
and built-in__import__()
. A module object has a namespace implemented by a dictionary object (this is the dictionary referenced by the__globals__
attribute of functions defined in the module). Attribute references are translated to lookups in this dictionary, e.g.,m.x
is equivalent tom.__dict__["x"]
. A module object does not contain the code object used to initialize the module (since it isn’t needed once the initialization is done).A atribuição de atributo atualiza o dicionário de espaço de nomes do módulo, por exemplo,
m.x = 1
é equivalente am.__dict__["x"] = 1
.Atributos predefinidos (graváveis):
__name__
é o nome do módulo;__doc__
é a string de documentação do módulo, ouNone
se indisponível;__annotations__
(opcional) é um dicionário contendo anotações de variáveis coletadas durante a execução do corpo do módulo;__file__
é o caminho do arquivo do qual o módulo foi carregado, se ele foi carregado de um arquivo. O atributo__file__
pode estar faltando para certos tipos de módulos, como módulos C que estão estaticamente vinculados ao interpretador; para módulos de extensão carregados dinamicamente de uma biblioteca compartilhada, é o nome do caminho do arquivo da biblioteca compartilhada.Atributo especial somente leitura:
__dict__
é o espaço de nomes do módulo como um objeto de dicionário.CPython implementation detail: Por causa da maneira como o CPython limpa os dicionários do módulo, 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.
- Classes Personalizadas
Tipos de classe personalizados são tipicamente criados por definições de classe (veja a seção Definições de classe). Uma classe possui um espaço de nomes implementado por um objeto de dicionário. As referências de atributos de classe são traduzidas para pesquisas neste dicionário, por exemplo,
Cx
é traduzido paraC.__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 “diamante”, onde há vários caminhos de herança que levam de volta a um ancestral comum. Detalhes adicionais sobre o C3 MRO usado pelo Python podem ser encontrados na documentação que acompanha a versão 2.3 em https://www.python.org/download/releases/2.3/mro/.Quando uma referência de atributo de classe (para uma classe
C
, digamos) produziria um objeto de método de classe, ele é transformado em um objeto de método de instância cujo atributo__self__
éC
. Quando produziria um objeto de método estático, ele é transformado no objeto encapsulado pelo objeto de método estático. Veja a seção Implementando descritores para outra maneira em que os atributos recuperados de uma classe podem diferir daqueles realmente contidos em seu__dict__
.As atribuições de atributos de classe atualizam o dicionário da classe, nunca o dicionário de uma classe base.
Um objeto de classe pode ser chamado (veja acima) para produzir uma instância de classe (veja abaixo).
Atributos especiais:
__name__
é o nome da classe;__module__
é o nome do módulo no qual a classe foi definida;__dict__
é o dicionário que contém o espaço de nomes da classe;__bases__
é uma tupla contendo as classes base, na ordem de sua ocorrência na lista de classes base;__doc__
é a string de documentação da classe, ouNone
se indefinido;__annotations__
(opcional) é um dicionário contendo anotações de variáveis coletadas durante a execução do corpo da classe.- Instância de Classe
Uma instância de classe é criada chamando um objeto de 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 de método de instância cujo atributo
__self__
é a instância. Métodos estáticos e objetos de método de classe também são transformados; veja acima em “Classes”. Veja a seção 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__dict__
da classe. Se nenhum atributo de classe for encontrado, e a classe do objeto tiver um método__getattr__()
, que é chamado para satisfazer a pesquisa.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
__setattr__()
ou__delattr__()
, ele é chamado ao invés de atualizar o dicionário da instância diretamente.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 Nomes de métodos especiais.
Atributos especiais:
__dict__
é o dicionário de atributos;__class__
é a classe da instância.- Objetos de E/S (também conhecidos como objetos arquivo)
O objeto de arquivo representa um arquivo aberto. Vários atalhos estão disponíveis para criar objetos arquivos: a função embutida
open()
, e tambémos.popen()
,os.fdopen()
e o métodomakefile()
de objetos soquete (e talvez por outras funções ou métodos fornecidos por módulos de extensão).Os objetos
sys.stdin
,sys.stdout
esys.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 abstrataio.TextIOBase
.- Tipos 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.
- Objeto Código
Objetos código representam código Python executável compilados em bytes ou 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.
Special read-only attributes:
co_name
gives the function name;co_argcount
is the number of positional arguments (including arguments with default values);co_nlocals
is the number of local variables used by the function (including arguments);co_varnames
is a tuple containing the names of the local variables (starting with the argument names);co_cellvars
is a tuple containing the names of local variables that are referenced by nested functions;co_freevars
is a tuple containing the names of free variables;co_code
is a string representing the sequence of bytecode instructions;co_consts
is a tuple containing the literals used by the bytecode;co_names
is a tuple containing the names used by the bytecode;co_filename
is the filename from which the code was compiled;co_firstlineno
is the first line number of the function;co_lnotab
is a string encoding the mapping from bytecode offsets to line numbers (for details see the source code of the interpreter);co_stacksize
is the required stack size (including local variables);co_flags
is an integer encoding a number of flags for the interpreter.Os seguintes bits de sinalizador são definidos para
co_flags
: o bit0x04
é definido se a função usa a sintaxe*arguments
para aceitar um número arbitrário de argumentos posicionais; o bit0x08
é definido se a função usa a sintaxe**keywords
para aceitar argumentos nomeados arbitrários; o bit0x20
é definido se a função for um gerador.Declarações de recursos futuros (
from __future__ import division
) também usam bits emco_flags
para indicar se um objeto código foi compilado com um recurso específico habilitado: o bit0x2000
é definido se a função foi compilada com divisão futura habilitada; os bits0x10
e0x1000
foram usados em versões anteriores do Python.Outros bits em
co_flags
são reservados para uso interno.Se um objeto código representa uma função, o primeiro item em
co_consts
é a string de documentação da função, ouNone
se indefinido.
- Objetos quadro
Frame objects represent execution frames. They may occur in traceback objects (see below).
Atributos especiais de somente leitura:
f_back
é para o quadro de pilha anterior (para o chamador), ouNone
se este é o quadro de pilha inferior;f_code
é o objeto código sendo executado neste quadro;f_locals
é o dicionário usado para procurar variáveis locais;f_globals
é usado para variáveis globais;f_builtins
é usado para nomes embutidos (intrínsecos);f_lasti
dá a instrução precisa (este é um índice para a string bytecode do objeto código).Special writable attributes:
f_trace
, if notNone
, is a function called at the start of each source code line (this is used by the debugger);f_lineno
is the current line number of the frame — writing to this from within a trace function jumps to the given line (only for the bottom-most frame). A debugger can implement a Jump command (aka Set Next Statement) by writing to f_lineno.Objetos quadro têm suporte a um método:
-
frame.
clear
()¶ Este método limpa todas as referências a variáveis locais mantidas pelo quadro. Além disso, se o quadro pertencer a um gerador, o gerador é finalizado. Isso ajuda a quebrar os ciclos de referência que envolvem objetos quadro (por exemplo, ao capturar uma exceção e armazenar seu traceback para uso posterior).
RuntimeError
é levantada se o quadro estiver em execução.Novo na versão 3.4.
-
- Objetos traceback
Traceback objects represent a stack trace of an exception. A traceback object is created when an exception occurs. When the search for an exception handler unwinds the execution stack, at each unwound level a traceback object is inserted in front of the current traceback. When an exception handler is entered, the stack trace is made available to the program. (See section The try statement.) It is accessible as the third item of the tuple returned by
sys.exc_info()
. When the program contains no suitable handler, the stack trace is written (nicely formatted) to the standard error stream; if the interpreter is interactive, it is also made available to the user assys.last_traceback
.Special read-only attributes:
tb_next
is the next level in the stack trace (towards the frame where the exception occurred), orNone
if there is no next level;tb_frame
points to the execution frame of the current level;tb_lineno
gives the line number where the exception occurred;tb_lasti
indicates the precise instruction. The line number and last instruction in the traceback may differ from the line number of its frame object if the exception occurred in atry
statement with no matching except clause or with a finally clause.- Objetos slice
Objetos slice são usados para representar fatias para métodos
__getitem__()
. Eles também são criados pela função embutidaslice()
.Atributos especiais de somente leitura:
start
é o limite inferior;stop
é o limite superior;step
é o valor intermediário; cada um éNone
se omitido. Esses atributos podem ter qualquer tipo.Objetos slice têm suporte a um método:
-
slice.
indices
(self, length)¶ Este método usa 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.
-
- Objetos método estáticos
Objetos método estáticos fornecem uma maneira de derrotar a transformação de objetos função em objetos método descritos acima. Um objeto método estático é um wrapper em torno de qualquer outro objeto, geralmente um objeto método definido pelo usuário. Quando um objeto método estático é recuperado de uma classe ou instância de classe, o objeto realmente retornado é o objeto envolto, que não está sujeito a nenhuma transformação posterior. Os objetos método estáticos não são chamáveis, embora os objetos que envolvem geralmente o sejam. Objetos método estáticos são criados pelo construtor embutido
staticmethod()
.- Objetos métodos 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 de método de classe após tal recuperação é descrito acima, em “Métodos definidos pelo usuário”. Objetos de método de classe são criados pelo construtor embutido
classmethod()
.
3.3. Nomes de métodos especiais¶
Uma classe pode implementar certas operações que são chamadas por sintaxe especial (como operações aritméticas ou subscript 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 __getitem__()
, e x
é uma instância desta classe, então x[i]
é aproximadamente equivalente a 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 AttributeError
ou TypeError
).
Definir um método especial para None
indica que a operação correspondente não está disponível. Por exemplo, se uma classe define __iter__()
para None
, a classe não é iterável, então chamar iter()
em suas instâncias irá levantar um TypeError
(sem retroceder para __getitem__()
). 2
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 NodeList
no Document Object Model do W3C.)
3.3.1. Customização básica¶
-
object.
__new__
(cls[, ...])¶ Chamado para criar uma nova instância da classe cls.
__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__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
__new__()
da superclasse usandosuper().__new__(cls[, ...])
com os argumentos apropriados e, em seguida, modificando a instância recém-criada conforme necessário antes de retorná-la.If
__new__()
returns an instance of cls, then the new instance’s__init__()
method will be invoked like__init__(self[, ...])
, where self is the new instance and the remaining arguments are the same as were passed to__new__()
.Se
__new__()
não retornar uma instância de cls, então o método__init__()
da nova instância não será invocado.__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.
-
object.
__init__
(self[, ...])¶ Chamado após a instância ter sido criada (por
__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__init__()
, o método__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:super().__init__([args...])
.Porque
__new__()
e :meth: __init__` trabalham juntos na construção de objetos (__new__()
para criá-lo e__init__()
para personalizá-lo), nenhum valor diferente deNone
pode ser retornado por__init__()
; fazer isso fará com que umaTypeError
seja levantada em tempo de execução.
-
object.
__del__
(self)¶ 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
__del__()
, o método__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
__del__()
adiar a destruição da instância criando uma nova referência a ela. Isso é chamado de ressurreição de objeto. Depende da implementação se__del__()
é chamado uma segunda vez quando um objeto ressuscitado está prestes a ser destruído; a implementação atual do CPython apenas o chama uma vez.Não é garantido que os métodos
__del__()
sejam chamados para objetos que ainda existam quando o interpretador sai.Nota
del x
não chama diretamentex.__del__()
– o primeiro diminui a contagem de referências parax
em um, e o segundo só é chamado quando a contagem de referências dex
atinge zero.CPython implementation detail: It is possible for a reference cycle to prevent the reference count of an object from going to zero. In this case, the cycle will be later detected and deleted by the cyclic garbage collector. A common cause of reference cycles is when an exception has been caught in a local variable. The frame’s locals then reference the exception, which references its own traceback, which references the locals of all frames caught in the traceback.
Ver também
Documentação do módulo
gc
.Aviso
Devido às circunstâncias precárias sob as quais os métodos
__del__()
são invocados, as exceções que ocorrem durante sua execução são ignoradas e um aviso é impresso emsys.stderr
em seu lugar. Em particular:__del__()
pode ser chamado quando um código arbitrário está sendo executado, incluindo de qualquer thread arbitrário. Se__del__()
precisar bloquear ou invocar qualquer outro recurso de bloqueio, pode ocorrer um deadlock, pois o recurso já pode ter sido levado pelo código que é interrompido para executar__del__()
.__del__()
pode ser executado durante o desligamento 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 comoNone
. O 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__del__()
for chamado.
-
object.
__repr__
(self)¶ Chamado pela função embutida
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<...alguma descrição útil...>
deve ser retornada. O valor de retorno deve ser um objeto string. Se uma classe define__repr__()
, mas não__str__()
, então__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.
-
object.
__str__
(self)¶ Chamado por
str(object)
e as funções embutidasformat()
eprint()
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 string.Este método difere de
object.__repr__()
por não haver expectativa de que__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
object
chamaobject.__repr__()
.
-
object.
__bytes__
(self)¶ Chamado por bytes para calcular uma representação de string de bytes de um objeto. Isso deve retornar um objeto
bytes
.
-
object.
__format__
(self, format_spec)¶ Called by the
format()
built-in function, and by extension, evaluation of formatted string literals and thestr.format()
method, to produce a “formatted” string representation of an object. Theformat_spec
argument is a string that contains a description of the formatting options desired. The interpretation of theformat_spec
argument is up to the type implementing__format__()
, however most classes will either delegate formatting to one of the built-in types, or use a similar formatting option syntax.Consulte 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.
Alterado na versão 3.4: O método __format__ do próprio
object
levanta umaTypeError
se passada qualquer string não vazia.
-
object.
__lt__
(self, other)¶ -
object.
__le__
(self, other)¶ -
object.
__eq__
(self, other)¶ -
object.
__ne__
(self, other)¶ -
object.
__gt__
(self, other)¶ -
object.
__ge__
(self, other)¶ 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:
x<y
chamax.__lt__(y)
,x<=y
chamax.__le__(y)
,x==y
chamax.__eq__(y)
,x!=y
chamax.__ne__(y)
,x>y
chamax.__gt__(y)
ex>=y
chamax.__ge__(y)
.Um método de comparação rico pode retornar o singleton
NotImplemented
se não implementar a operação para um determinado par de argumentos. Por convenção,False
eTrue
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çãoif
), Python irá chamarbool()
no valor para determinar se o resultado for verdadeiro ou falso.Por padrão,
__ne__()
delega para__eq__()
e inverte o resultado a menos que sejaNotImplemented
. Não há outras relações implícitas entre os operadores de comparação, por exemplo, a verdade de(x<y or x==y)
não implicax<=y
. Para gerar operações de ordenação automaticamente a partir de uma única operação raiz, consultefunctools.total_ordering()
.Veja o parágrafo sobre
__hash__()
para algumas notas importantes sobre a criação de objetos hasheáveis que suportam 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 suporta à operação, mas o argumento direito sim); em vez disso,
__lt__()
e__gt__()
são o reflexo um do outro,__le__()
e__ge__()
são o reflexo um do outro, e__eq__()
e__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. A subclasse virtual não é considerada.
-
object.
__hash__
(self)¶ Chamado pela função embutida
hash()
e para operações em membros de coleções em hash incluindoset
,frozenset
edict
.__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:def __hash__(self): return hash((self.name, self.nick, self.color))
Nota
hash()
trunca o valor retornado do método__hash__()
personalizado de um objeto para o tamanho de umPy_ssize_t
. Isso é normalmente 8 bytes em compilações de 64 bits e 4 bytes em compilações de 32 bits. Se o__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 suportadas. Uma maneira fácil de fazer isso é compython -c "import sys; print(sys.hash_info.width)"
.Se uma classe não define um método
__eq__()
, ela também não deve definir uma operação__hash__()
; se define__eq__()
mas não__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__eq__()
, ela não deve implementar__hash__()
, uma vez que a implementação de coleções 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
__eq__()
e__hash__()
por padrão; com eles, todos os objetos se comparam desiguais (exceto com eles mesmos) ex.__hash__()
retorna um valor apropriado tal quex == y
implica quex is y
ehash(x) == hash(y)
.A class that overrides
__eq__()
and does not define__hash__()
will have its__hash__()
implicitly set toNone
. When the__hash__()
method of a class isNone
, instances of the class will raise an appropriateTypeError
when a program attempts to retrieve their hash value, and will also be correctly identified as unhashable when checkingisinstance(obj, collections.Hashable)
.Se uma classe que sobrescreve
__eq__()
precisa manter a implementação de__hash__()
de uma classe pai, o interpretador deve ser informado disso explicitamente pela configuração__hash__ = <ClassePai>.__hash__
.If a class that does not override
__eq__()
wishes to suppress hash support, it should include__hash__ = None
in the class definition. A class which defines its own__hash__()
that explicitly raises aTypeError
would be incorrectly identified as hashable by anisinstance(obj, collections.Hashable)
call.Nota
By default, the
__hash__()
values of str, bytes and datetime objects are “salted” with an unpredictable random value. Although they remain constant within an individual Python process, they are not predictable between repeated invocations of Python.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^2). Consulte http://www.ocert.org/advisories/ocert-2011-003.html para obter detalhes.
Changing hash values affects the iteration order of dicts, sets and other mappings. Python has never made guarantees about this ordering (and it typically varies between 32-bit and 64-bit builds).
Consulte também
PYTHONHASHSEED
.Alterado na versão 3.3: Aleatorização de hash está habilitada por padrão.
-
object.
__bool__
(self)¶ Chamado para implementar o teste de valor de verdade e a operação embutida
bool()
; deve retornarFalse
ouTrue
. Quando este método não é definido,__len__()
é chamado, se estiver definido, e o objeto é considerado verdadeiro se seu resultado for diferente de zero. Se uma classe não define__len__()
nem__bool__()
, todas as suas instâncias são consideradas verdadeiras.
3.3.2. 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 x.name
) para instâncias de classe.
-
object.
__getattr__
(self, name)¶ Chamado quando o acesso padrão ao atributos falha com um
AttributeError
(ou__getattribute__()
levanta umaAttributeError
porque name não é um atributo de instância ou um atributo na árvore de classes paraself
; ou__get__()
de uma propriedade name levantaAttributeError
). Este método deve retornar o valor do atributo (calculado) ou levantar uma exceçãoAttributeError
.Observe que se o atributo for encontrado através do mecanismo normal,
__getattr__()
não é chamado. (Esta é uma assimetria intencional entre__getattr__()
e__setattr__()
.) Isso é feito tanto por razões de eficiência quanto porque__getattr__()
não teria como acessar outros atributos da instância. Observe que pelo menos para variáveis de instâncias, você pode fingir 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__getattribute__()
abaixo para uma maneira de realmente obter controle total sobre o acesso ao atributo.
-
object.
__getattribute__
(self, name)¶ Chamado incondicionalmente para implementar acessos a atributo para instâncias da classe. Se a classe também define
__getattr__()
, o último não será chamado a menos que__getattribute__()
o chame explicitamente ou levante umAttributeError
. Este método deve retornar o valor do atributo (calculado) ou levantar uma exceçãoAttributeError
. 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,object.__getattribute__(self, name)
.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 funções embutidas. Consulte Pesquisa de método especial.
-
object.
__setattr__
(self, name, value)¶ Chamado quando uma atribuição de atributo é tentada. Isso é 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
__setattr__()
deseja atribuir a um atributo de instância, ele deve chamar o método da classe base com o mesmo nome, por exemplo,object.__setattr__(self, name, value)
.
-
object.
__delattr__
(self, name)¶ Como
__setattr__()
, mas para exclusão de atributo em vez de atribuição. Isso só deve ser implementado sedel obj.name
for significativo para o objeto.
-
object.
__dir__
(self)¶ Chamado quando
dir()
é chamado no objeto. Uma sequência deve ser retornada.dir()
converte a sequência retornada em uma lista e a ordena.
3.3.2.1. Personalizando acesso a atributos de módulos¶
Para uma personalização mais refinada do comportamento do módulo (definição de atributos, propriedades etc.), pode-se definir o atributo __class__
de um objeto de módulo para uma subclasse de types.ModuleType
. Por exemplo:
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}...')
setattr(self, attr, value)
sys.modules[__name__].__class__ = VerboseModule
Nota
Setting module __class__
only affects lookups made using the attribute
access syntax – directly accessing the module globals (whether by code
within the module, or via a reference to the module’s globals dictionary)
is unaffected.
Alterado na versão 3.5: O atributo de módulo __class__
pode agora ser escrito.
3.3.2.2. 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 __dict__
da classe proprietária.
-
object.
__get__
(self, instance, owner)¶ Called to get the attribute of the owner class (class attribute access) or of an instance of that class (instance attribute access). owner is always the owner class, while instance is the instance that the attribute was accessed through, or
None
when the attribute is accessed through the owner. This method should return the (computed) attribute value or raise anAttributeError
exception.
-
object.
__set__
(self, instance, value)¶ Chamado para definir o atributo em uma instância instance da classe proprietária para um novo valor, value.
-
object.
__delete__
(self, instance)¶ Chamado para excluir o atributo em uma instância instance da classe proprietária.
-
object.
__set_name__
(self, owner, name)¶ Chamado no momento em que a classe proprietária owner é criada. O descritor foi atribuído a name.
Novo na versão 3.6.
O atributo __objclass__
é interpretado pelo módulo inspect
como especificando 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).
3.3.2.3. Invoking Descriptors¶
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: __get__()
, __set__()
e __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, a.x
tem uma cadeia de pesquisa começando com a.__dict__['x']
, então type(a).__dict__['x']
, e contando pelas classes base de type(a)
excluindo metaclasses.
No entanto, se o valor pesquisado for um objeto que define um dos métodos do descritor, o 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, a.x
. Como os argumentos são montados depende de a
:
- Chamada direta
A chamada mais simples e menos comum é quando o código do usuário invoca diretamente um método descritor:
x.__get__(a)
.- Ligação de instâncias
Se estiver ligando a uma instância de objeto,
a.x
é transformado na chamada:type(a).__dict__['x'].__get__(a, type(a))
.- Ligação de classes
Se estiver ligando a uma classe,
A.x
é transformado na chamada:A.__dict__['x'].__get__(None, A)
.- Ligação de super
Se
a
é uma instância desuper
, então a ligaçãosuper(B, obj).m()
procuraobj.__class__.__mro__
para a classe baseA
precedendo imediatamenteB
e, em seguida, invoca o descritor com a chamada:A.__dict__['m'].__get__(obj, obj.__class__)
.
For instance bindings, the precedence of descriptor invocation depends on the
which descriptor methods are defined. A descriptor can define any combination
of __get__()
, __set__()
and __delete__()
. If it does not
define __get__()
, then accessing the attribute will return the descriptor
object itself unless there is a value in the object’s instance dictionary. If
the descriptor defines __set__()
and/or __delete__()
, it is a data
descriptor; if it defines neither, it is a non-data descriptor. Normally, data
descriptors define both __get__()
and __set__()
, while non-data
descriptors have just the __get__()
method. Data descriptors with
__set__()
and __get__()
defined always override a redefinition in an
instance dictionary. In contrast, non-data descriptors can be overridden by
instances.
Os métodos Python (incluindo staticmethod()
e 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 property()
é implementada como um descritor de dados. Da mesma forma, as instâncias não podem substituir o comportamento de uma propriedade.
3.3.2.4. __slots__¶
__slots__ permite-nos declarar explicitamente membros de dados (como propriedades) e negar a criação de __dict__ e __weakref__ (a menos que explicitamente declarado em __slots__ ou disponível em um pai.)
The space saved over using __dict__ can be significant.
-
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 __dict__ e __weakref__ para cada instância.
3.3.2.4.1. Observações ao uso de __slots__¶
Ao herdar de uma classe sem __slots__, os atributos __dict__ e __weakref__ das instâncias vão sempre ser acessíveis.
Sem uma variável __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
AttributeError
. Se a atribuição dinâmica de novas variáveis for desejada, então adicione'__dict__'
à sequência de strings na declaração __slots__.Sem uma variável __weakref__ para cada instância, as classes que definem __slots__ não suportam referências fracas para suas instâncias. Se for necessário um suporte de referência fraca, adicione
'__weakref__'
à sequência de strings na declaração __slots__.__slots__ são implementados no nível de classe criando descritores (Implementando 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.
A ação de uma declaração __slots__ se limita à classe em que é definida. *__slots__ declarados nos pais estão disponíveis nas classes infantis. No entanto, as subclasses filhas receberão um __dict__ * e *__weakref__ a menos que também definam __slots__ (que deve conter apenas nomes de quaisquer slots adicionais).
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.
Não vazio __slots__ não funciona para classes derivadas de tipos embutidos de “comprimento variável”, como
int
,bytes
etuple
.Qualquer iterável não string pode ser atribuído a __slots__. Mapeamentos também podem ser usados; entretanto, no futuro, um significado especial pode ser atribuído aos valores correspondentes a cada chave.
Atribuição de __class__ funciona apenas se ambas as classes têm o mesmo __slots__.
A herança múltipla com várias classes pai com slots pode ser usada, mas apenas um pai tem permissão para ter atributos criados por slots (as outras bases devem ter layouts de slots vazios) – violações levantam
TypeError
.
3.3.3. Personalizando a criação de classe¶
Sempre que uma classe herda de outra classe, __init_subclass__ é chamado nessa classe. 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, __init_subclass__
aplica-se apenas a futuras subclasses da classe que define o 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 a classe pai
__init_subclass__
. Para compatibilidade com outras classes usando__init_subclass__
, deve-se retirar os argumentos nomeados necessários e passar os outros para a classe base, como em: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
A implementação padrão
object.__init_subclass__
não faz nada, mas levanta um erro se for chamada com quaisquer argumentos.Nota
A dica da metaclasse
metaclass
é consumida pelo resto da maquinaria de tipo, e nunca é passada para implementações__init_subclass__
. A metaclasse real (em vez da dica explícita) pode ser acessada comotype(cls)
.Novo na versão 3.6.
3.3.3.1. Metaclasses¶
Por padrão, as classes são construídas usando type()
. O corpo da classe é executado em um novo espaço de nomes e o nome da classe é vinculado localmente ao resultado de type(name, bases, namespace)
.
O processo de criação da classe pode ser personalizado passando o argumento nomeado metaclass
na linha de definição da classe, ou herdando de uma classe existente que incluiu tal argumento. No exemplo a seguir, MyClass
e MySubclass
são instâncias de Meta
:
class Meta(type):
pass
class MyClass(metaclass=Meta):
pass
class MySubclass(MyClass):
pass
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:
the appropriate metaclass is determined
the class namespace is prepared
the class body is executed
the class object is created
3.3.3.2. Determinando a metaclasse apropriada¶
A metaclasse apropriada para uma definição de classe é determinada da seguinte forma:
if no bases and no explicit metaclass are given, then
type()
is usedif an explicit metaclass is given and it is not an instance of
type()
, then it is used directly as the metaclassif an instance of
type()
is given as the explicit metaclass, or bases are defined, then the most derived metaclass is used
A metaclasse mais derivada é selecionada a partir da metaclasse explicitamente especificada (se houver) e das metaclasses (ou seja, type(cls)
) de todas as classes básicas 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 TypeError
.
3.3.3.3. Preparando o espaço de nomes da classe¶
Once the appropriate metaclass has been identified, then the class namespace
is prepared. If the metaclass has a __prepare__
attribute, it is called
as namespace = metaclass.__prepare__(name, bases, **kwds)
(where the
additional keyword arguments, if any, come from the class definition).
Se a metaclasse não tiver o atributo __prepare__
, então o espaço de nomes da classe é inicializado como um mapeamento ordenado vazio.
Ver também
- PEP 3115 - Metaclasses no Python 3000
Introduzido o gancho de espaço de nomes
__prepare__
3.3.3.4. Executando o corpo da classe¶
O corpo da classe é executado (aproximadamente) como exec(body, globals(), namespace)
. A principal diferença de uma chamada normal para 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 __class__
descrita na próxima seção.
3.3.3.5. Criando o objeto da classe¶
Uma vez que o espaço de nomes da classe tenha sido preenchido executando o corpo da classe, o objeto da classe é criado chamando metaclass(name, bases, namespace, **kwds)
(os argumentos adicionais passados aqui são os mesmos passados para __prepare__
).
Este objeto classe é aquele que será referenciado pela forma de argumento zero de super()
. __class__
é uma referência implícita de fechamento criada pelo compilador se qualquer método em um corpo de classe se referir a __class__
ou super
. Isso permite que a forma de argumento zero de 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.
CPython implementation detail: In CPython 3.6 and later, the __class__
cell is passed to the metaclass
as a __classcell__
entry in the class namespace. If present, this must
be propagated up to the type.__new__
call in order for the class to be
initialised correctly.
Failing to do so will result in a DeprecationWarning
in Python 3.6,
and a RuntimeError
in Python 3.8.
Ao usar a metaclasse padrão type
, ou qualquer metaclasse que finalmente chama type.__new__
, as seguintes etapas de personalização adicionais são invocadas após a criação do objeto classe:
primeiro,
type.__new__
coleta todos os descritores no espaço de nomes da classe que definem um método__set_name__()
;second, all of these
__set_name__
methods are called with the class being defined and the assigned name of that particular descriptor; andfinalmente, o gancho
__init_subclass__()
é chamado no pai imediato da nova classe em sua ordem de resolução de métodos.
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 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 __dict__
do objeto classe.
Ver também
- PEP 3135 - Novo super
Descreve a referência implícita de fechamento de
__class__
3.3.3.6. Usos para metaclasses¶
Os usos potenciais para metaclasses são ilimitados. Algumas ideias que foram exploradas incluem enum, criação de log, verificação de interface, delegação automática, criação automática de propriedade, proxies, estruturas e bloqueio/sincronização automático/a de recursos.
3.3.4. 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 isinstance()
e issubclass()
.
Em particular, a metaclasse 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.
-
class.
__instancecheck__
(self, instance)¶ Retorna verdadeiro se instance deve ser considerada uma instância (direta ou indireta) da classe class. Se definido, chamado para implementar
isinstance(instance, class)
.
-
class.
__subclasscheck__
(self, subclass)¶ Retorna verdadeiro se subclass deve ser considerada uma subclasse (direta ou indireta) da classe class. Se definido, chamado para implementar
issubclass(subclass, class)
.
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.
Ver também
- PEP 3119 - Introducing Abstract Base Classes
Inclui a especificação para personalizar o comportamento de
isinstance()
eissubclass()
através de__instancecheck__()
e__subclasscheck__()
, com motivação para esta funcionalidade no contexto da adição de classes base abstratas (veja o móduloabc
) para a linguagem.
3.3.5. Emulando objetos chamáveis¶
-
object.
__call__
(self[, args...])¶ Chamado quando a instância é “chamada” como uma função; se este método for definido,
x(arg1, arg2, ...)
é uma abreviatura parax.__call__(arg1, arg2, ...)
.
3.3.6. Emulando de tipos contêineres¶
The following methods can be defined to implement container objects. Containers
usually are sequences (such as lists or tuples) or mappings (like dictionaries),
but can represent other containers as well. The first set of methods is used
either to emulate a sequence or to emulate a mapping; the difference is that for
a sequence, the allowable keys should be the integers k for which 0 <= k <
N
where N is the length of the sequence, or slice objects, which define a
range of items. It is also recommended that mappings provide the methods
keys()
, values()
, items()
, get()
, clear()
,
setdefault()
, pop()
, popitem()
, copy()
, and
update()
behaving similar to those for Python’s standard dictionary
objects. The collections
module provides a
MutableMapping
abstract base class to help create those methods from a base set of
__getitem__()
, __setitem__()
, __delitem__()
, and keys()
.
Mutable sequences should provide methods append()
, count()
,
index()
, extend()
, insert()
, pop()
, remove()
,
reverse()
and sort()
, like Python standard list objects. Finally,
sequence types should implement addition (meaning concatenation) and
multiplication (meaning repetition) by defining the methods __add__()
,
__radd__()
, __iadd__()
, __mul__()
, __rmul__()
and
__imul__()
described below; they should not define other numerical
operators. It is recommended that both mappings and sequences implement the
__contains__()
method to allow efficient use of the in
operator; for
mappings, in
should search the mapping’s keys; for sequences, it should
search through the values. It is further recommended that both mappings and
sequences implement the __iter__()
method to allow efficient iteration
through the container; for mappings, __iter__()
should be the same as
keys()
; for sequences, it should iterate through the values.
-
object.
__len__
(self)¶ Chamado para implementar a função embutida
len()
. Deve retornar o comprimento do objeto, um inteiro>=
0. Além disso, um objeto que não define um método__bool__()
e cujo método__len__()
retorna zero é considerado como falso em um contexto booleano.CPython implementation detail: No CPython, o comprimento deve ser no máximo
sys.maxsize
. Se o comprimento for maior quesys.maxsize
, alguns recursos (comolen()
) podem levantarOverflowError
. Para evitar levantarOverflowError
pelo teste de valor de verdade, um objeto deve definir um método__bool__()
.
-
object.
__length_hint__
(self)¶ Called to implement
operator.length_hint()
. Should return an estimated length for the object (which may be greater or less than the actual length). The length must be an integer>=
0. This method is purely an optimization and is never required for correctness.Novo na versão 3.4.
Nota
O fatiamento é feito exclusivamente com os três métodos a seguir. Uma chamada como
a[1:2] = b
é traduzida com
a[slice(1, 2, None)] = b
e assim por diante. Os itens de fatia ausentes são sempre preenchidos com None
.
-
object.
__getitem__
(self, key)¶ Chamado para implementar a avaliação de
self[key]
. Para tipos de sequência, as chaves aceitas devem ser inteiros e objetos fatia. Observe que a interpretação especial de índices negativos (se a classe deseja emular um tipo de sequência) depende do método__getitem__()
. Se key for de um tipo impróprio,TypeError
pode ser levantada; se de um valor fora do conjunto de índices para a sequência (após qualquer interpretação especial de valores negativos),IndexError
deve ser levantada. Para tipos de mapeamento, se key estiver faltando (não no contêiner),KeyError
deve ser levantada.Nota
Os loops
for
esperam que umaIndexError
seja levantada para índices ilegais para permitir a detecção apropriada do fim da sequência.
-
object.
__setitem__
(self, key, value)¶ Chamado para implementar a atribuição de
self[key]
. Mesma nota que para__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__getitem__()
.
-
object.
__delitem__
(self, key)¶ Chamado para implementar a exclusão de
self[key]
. Mesma nota que para__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__getitem__()
.
-
object.
__missing__
(self, key)¶ Chamado por
dict
.__getitem__()
para implementarself[key]
para subclasses de dicionário quando a chave não estiver no dicionário.
-
object.
__iter__
(self)¶ Este método é chamado quando um 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.
Os objetos iteradores também precisam implementar este método; eles são obrigados a retornar. Para obter mais informações sobre objetos iteradores, consulte Tipos de Iteradores.
-
object.
__reversed__
(self)¶ Chamado (se presente) pelo
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
__reversed__()
não for fornecido, oreversed()
embutido voltará a usar o protocolo de sequência (__len__()
e__getitem__()
). Objetos que suportam o protocolo de sequência só devem fornecer__reversed__()
se eles puderem fornecer uma implementação que seja mais eficiente do que aquela fornecida porreversed()
.
The membership test operators (in
and not in
) are normally
implemented as an iteration through a sequence. However, container objects can
supply the following special method with a more efficient implementation, which
also does not require the object be a sequence.
-
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
__contains__()
, o teste de associação primeiro tenta a iteração via__iter__()
, depois o protocolo de iteração de sequência antigo via__getitem__()
, consulte esta seção em a referência da linguagem.
3.3.7. 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.
-
object.
__add__
(self, other)¶ -
object.
__sub__
(self, other)¶ -
object.
__mul__
(self, other)¶ -
object.
__matmul__
(self, other)¶ -
object.
__truediv__
(self, other)¶ -
object.
__floordiv__
(self, other)¶ -
object.
__mod__
(self, other)¶ -
object.
__divmod__
(self, other)¶ -
object.
__pow__
(self, other[, modulo])¶ -
object.
__lshift__
(self, other)¶ -
object.
__rshift__
(self, other)¶ -
object.
__and__
(self, other)¶ -
object.
__xor__
(self, other)¶ -
object.
__or__
(self, other)¶ Esses métodos são chamados para implementar as operações aritméticas binárias (
+
,-
,*
,@
,/
,//
,%
,divmod()
,pow()
,**
,<<
,>>
,&
,^
,|
). Por exemplo, para avaliar a expressãox + y
, onde x é uma instância de uma classe que tem um método__add__()
,x.__add__(y)
é chamado. O método__divmod__()
deve ser equivalente a usar__floordiv__()
e__mod__()
; não deve estar relacionado a__truediv__()
. Note que__pow__()
deve ser definido para aceitar um terceiro argumento opcional se a versão ternária da função internapow()
for suportada.Se um desses métodos não suporta a operação com os argumentos fornecidos, ele deve retornar
NotImplemented
.
-
object.
__radd__
(self, other)¶ -
object.
__rsub__
(self, other)¶ -
object.
__rmul__
(self, other)¶ -
object.
__rmatmul__
(self, other)¶ -
object.
__rtruediv__
(self, other)¶ -
object.
__rfloordiv__
(self, other)¶ -
object.
__rmod__
(self, other)¶ -
object.
__rdivmod__
(self, other)¶ -
object.
__rpow__
(self, other)¶ -
object.
__rlshift__
(self, other)¶ -
object.
__rrshift__
(self, other)¶ -
object.
__rand__
(self, other)¶ -
object.
__rxor__
(self, other)¶ -
object.
__ror__
(self, other)¶ Esses métodos são chamados para implementar as operações aritméticas binárias (
+
,-
,*
,@
,/
,//
,%
,divmod()
,pow()
,**
,<<
,>>
,&
,^
,|
) com operandos refletidos (trocados). Essas funções são chamadas apenas se o operando esquerdo não suportar a operação correspondente 3 e os operandos forem de tipos diferentes. 4 Por exemplo, para avaliar a expressãox - y
, onde y é uma instância de uma classe que tem um método__rsub__()
,y.__rsub__(x)
é chamado sex.__sub__(y)
retorna NotImplemented.Note que ternário
pow()
não tentará chamar__rpow__()
(as regras de coerção se tornariam muito complicadas).Nota
If the right operand’s type is a subclass of the left operand’s type and that subclass provides the reflected method for the operation, this method will be called before the left operand’s non-reflected method. This behavior allows subclasses to override their ancestors’ operations.
-
object.
__iadd__
(self, other)¶ -
object.
__isub__
(self, other)¶ -
object.
__imul__
(self, other)¶ -
object.
__imatmul__
(self, other)¶ -
object.
__itruediv__
(self, other)¶ -
object.
__ifloordiv__
(self, other)¶ -
object.
__imod__
(self, other)¶ -
object.
__ipow__
(self, other[, modulo])¶ -
object.
__ilshift__
(self, other)¶ -
object.
__irshift__
(self, other)¶ -
object.
__iand__
(self, other)¶ -
object.
__ixor__
(self, other)¶ -
object.
__ior__
(self, other)¶ Esses métodos são chamados para implementar as atribuições aritméticas aumentadas (
+=
,-=
,*=
,@=
,/=
,//=
,%=
,**=
,<<=
,>>=
,&=
,^=
,|=
). 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, a atribuição aumentada volta aos métodos normais. Por exemplo, se x é uma instância de uma classe com um método__iadd__()
,x += y
é equivalente ax = x.__iadd__(y)
. Caso contrário,x.__add__(y)
ey.__radd__(x)
são considerados, como com a avaliação dex + y
. Em certas situações, a atribuição aumentada pode resultar em erros inesperados (ver Porque a_tuple[i] += [‘item’] levanta uma exceção quando a adição funciona?), mas este comportamento é na verdade parte do modelo de dados.
-
object.
__neg__
(self)¶ -
object.
__pos__
(self)¶ -
object.
__abs__
(self)¶ -
object.
__invert__
(self)¶ Chamado para implementar as operações aritméticas unárias (
-
,+
,abs()
e~
).
-
object.
__complex__
(self)¶ -
object.
__int__
(self)¶ -
object.
__float__
(self)¶ Chamado para implementar as funções embutidas
complex()
,int()
efloat()
. Deve retornar um valor do tipo apropriado.
-
object.
__index__
(self)¶ Chamado para implementar
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 embutidasbin()
,hex()
eoct()
). A presença deste método indica que o objeto numérico é do tipo inteiro. Deve retornar um número inteiro.Nota
In order to have a coherent integer type class, when
__index__()
is defined__int__()
should also be defined, and both should return the same value.
-
object.
__round__
(self[, ndigits])¶ -
object.
__trunc__
(self)¶ -
object.
__floor__
(self)¶ -
object.
__ceil__
(self)¶ Chamado para implementar as funções embutidas
round()
etrunc()
,floor()
eceil()
demath
. A menos que ndigits sejam passados para__round__()
todos estes métodos devem retornar o valor do objeto truncado para umIntegral
(tipicamente umint
).Se
__int__()
não for definido, então a função embutidaint()
retrocede para__trunc__()
.
3.3.8. Com gerenciadores de contexto de instruções¶
A context manager is an object that defines the runtime context to be
established when executing a with
statement. The context manager
handles the entry into, and the exit from, the desired runtime context for the
execution of the block of code. Context managers are normally invoked using the
with
statement (described in section The with statement), but can also be
used by directly invoking their methods.
Os usos típicos de gerenciadores de contexto incluem salvar e restaurar vários tipos de estado global, bloquear e desbloquear recursos, fechar arquivos abertos, etc.
Para obter mais informações sobre gerenciadores de contexto, consulte Tipos de Gerenciador de Contexto.
-
object.
__enter__
(self)¶ Enter the runtime context related to this object. The
with
statement will bind this method’s return value to the target(s) specified in theas
clause of the statement, if any.
-
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
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
__exit__()
não devem relançar a exceção passada; esta é a responsabilidade do chamador.
3.3.9. 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:
>>> 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()
A justificativa por trás desse comportamento está em uma série de métodos especiais como __hash__()
e __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 chamados no próprio objeto do tipo:
>>> 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
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:
>>> type(1).__hash__(1) == hash(1)
True
>>> type(int).__hash__(int) == hash(int)
True
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 __getattribute__()
mesmo da metaclasse do objeto:
>>> 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
Ignorar a maquinaria de __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).
3.4. Coroutines¶
3.4.1. Objetos aguardáveis¶
An awaitable object generally implements an __await__()
method.
Coroutine objects returned from async def
functions
are awaitable.
Nota
Os objetos iteradores geradores retornados de geradores decorados com types.coroutine()
ou asyncio.coroutine()
também são aguardáveis, mas eles não implementam __await__()
.
-
object.
__await__
(self)¶ Deve retornar um iterador. Deve ser usado para implementar objetos aguardáveis. Por exemplo,
asyncio.Future
implementa este método para ser compatível com a expressãoawait
.
Novo na versão 3.5.
Ver também
PEP 492 para informações adicionais sobre objetos aguardáveis.
3.4.2. Objetos Coroutine¶
Coroutine objects are awaitable objects.
A coroutine’s execution can be controlled by calling __await__()
and
iterating over the result. When the coroutine has finished executing and
returns, the iterator raises StopIteration
, and the exception’s
value
attribute holds the return value. If the
coroutine raises an exception, it is propagated by the iterator. Coroutines
should not directly raise unhandled StopIteration
exceptions.
As corrotinas também têm os métodos listados abaixo, que são análogos aos dos geradores (ver Generator-iterator methods). No entanto, ao contrário dos geradores, as corrotinas não suportam diretamente a iteração.
Alterado na versão 3.5.2: É uma RuntimeError
para aguardar uma corrotina mais de uma vez.
-
coroutine.
send
(value)¶ Inicia ou retoma a execução da corrotina. Se value for
None
, isso é equivalente a avançar o iterador retornado por__await__()
. Se value não forNone
, este método delega para o métodosend()
do iterador que causou a suspensão da corrotina. O resultado (valor de retorno,StopIteration
ou outra exceção) é o mesmo de iterar sobre o valor de retorno__await__()
, descrito acima.
-
coroutine.
throw
(type[, value[, traceback]])¶ Levanta a exceção especificada na corrotina. Este método delega ao método
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,StopIteration
ou outra exceção) é o mesmo de iterar sobre o valor de retorno__await__()
, descrito acima. Se a exceção não for capturada na corrotina, ela se propagará de volta para o chamador.
-
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
close()
do iterador que causou a suspensão da corrotina, se tiver tal método. Então ele levantaGeneratorExit
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.
3.4.3. Iteradores Assíncronos¶
An asynchronous iterable is able to call asynchronous code in its
__aiter__
implementation, and an asynchronous iterator can call
asynchronous code in its __anext__
method.
Os iteradores assíncronos podem ser usados em uma instrução async for
.
-
object.
__aiter__
(self)¶ Deve retornar um objeto iterador assíncrono.
-
object.
__anext__
(self)¶ Deve retornar um aguardável resultando em um próximo valor do iterador. Deve levantar um erro exc:`StopAsyncIteration quando a iteração terminar.
Um exemplo de objeto iterável assíncrono:
class Reader:
async def readline(self):
...
def __aiter__(self):
return self
async def __anext__(self):
val = await self.readline()
if val == b'':
raise StopAsyncIteration
return val
Novo na versão 3.5.
Nota
Alterado na versão 3.5.2: Starting with CPython 3.5.2, __aiter__
can directly return
asynchronous iterators. Returning
an awaitable object will result in a
PendingDeprecationWarning
.
The recommended way of writing backwards compatible code in
CPython 3.5.x is to continue returning awaitables from
__aiter__
. If you want to avoid the PendingDeprecationWarning
and keep the code backwards compatible, the following decorator
can be used:
import functools
import sys
if sys.version_info < (3, 5, 2):
def aiter_compat(func):
@functools.wraps(func)
async def wrapper(self):
return func(self)
return wrapper
else:
def aiter_compat(func):
return func
Exemplo:
class AsyncIterator:
@aiter_compat
def __aiter__(self):
return self
async def __anext__(self):
...
Starting with CPython 3.6, the PendingDeprecationWarning
will be replaced with the DeprecationWarning
.
In CPython 3.7, returning an awaitable from __aiter__
will
result in a RuntimeError
.
3.4.4. 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 __aenter__
e __aexit__
.
Os gerenciadores de contexto assíncronos podem ser usados em uma instrução async with
.
-
object.
__aenter__
(self)¶ This method is semantically similar to the
__enter__()
, with only difference that it must return an awaitable.
-
object.
__aexit__
(self, exc_type, exc_value, traceback)¶ This method is semantically similar to the
__exit__()
, with only difference that it must return an awaitable.
Um exemplo de uma classe gerenciadora de contexto assíncrona:
class AsyncContextManager:
async def __aenter__(self):
await log('entering context')
async def __aexit__(self, exc_type, exc, tb):
await log('exiting context')
Novo na versão 3.5.
Notas de Rodapé
- 1
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.
- 2
Os métodos
__hash__()
,__iter__()
,__reversed__()
e__contains__()
têm um tratamento especial para isso; outros ainda irão gerar umTypeError
, mas podem fazer isso contando com o comportamento de queNone
não pode ser chamado.- 3
“Não suportar” aqui significa que a classe não possui tal método, ou o método retorna
NotImplemented
. Não defina o método comoNone
se quiser forçar o fallback para o método refletido do operando correto – isso terá o efeito oposto de bloquear explicitamente esse fallback.- 4
For operands of the same type, it is assumed that if the non-reflected method (such as
__add__()
) fails the operation is not supported, which is why the reflected method is not called.