3. Modelo de dados

3.1. Objetos, valores e tipos

Objetos são abstrações do Python para dados. Todos dados em um programa Python são 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 ‘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 length?”) 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 tipo do objeto também é imutável. 1

O valor de alguns objetos pode mudar. Objetos cujos valores podem mudar são descritos como mutáveis, objetos cujo valor não pode ser mudado uma vez que foram criados são chamados imutáveis. (O valor de um objeto contêiner que contém uma referência a um objeto mutável pode mudar quando o valor deste último for mudado; no entanto o contêiner é ainda assim considerada imutável, pois a coleção de objetos que contém não pode ser mudada. Então a imutabilidade não é estritamente o mesmo do que não haver mudanças de valor, é mais sutil.) A mutabilidade de um objeto é determinada pelo seu tipo; por exemplo, números, strings e tuplas são imutáveis, enquanto dicionários e listas são mutáveis.

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ências com detecção atrasada (opcional) de lixo ligado ciclicamente, que coleta a maioria dos objetos assim que eles se tornam inacessíveis, mas não é garantido que coletará lixo contendo referências circulares. Veja a documentação do módulo gc para informações sobre como controlar a coleta de lixo cíclico. Outras implementações agem de forma diferente e o CPython pode mudar. Não dependa da finalização imediata dos objetos quando eles se tornarem inacessíveis (isto é, você deve sempre fechar os arquivos explicitamente).

Observe que o uso dos recursos de rastreamento ou depuração da implementação pode manter os objetos ativos que normalmente seriam coletáveis. Observe também que capturar uma exceção com uma instrução “tryexcept” 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 “tryfinally” 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

Este tipo possui um único valor. Existe um único objeto com este valor. Este objeto é acessado através do nome embutido NotImplemented. Os métodos numéricos e métodos de comparação rica devem retornar esse valor se não implementarem a operação para os operandos fornecidos. (O interpretador tentará então a operação refletida ou alguma outra alternativa, dependendo do operador.) Não deve ser avaliado em um contexto booleano.

Veja a documentação Implementing the arithmetic operations para mais detalhes.

Alterado na versão 3.9: A avaliação de NotImplemented em um contexto booleano foi descontinuado. Embora atualmente seja avaliado como verdadeiro, ele emitirá um DeprecationWarning. Ele levantará uma TypeError em uma versão futura do Python.

Ellipsis

Este tipo possui um único valor. Existe um único objeto com este valor. Este objeto é acessado através do literal ... ou do nome embutido Ellipsis (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.

As representações de string das classes numéricas, calculadas por __repr__() e __str__(), têm as seguintes propriedades:

  • Elas são literais numéricos válidos que, quando passados para seu construtor de classe, produzem um objeto com o valor do numérico original.

  • A representação está na base 10, quando possível.

  • Os zeros à esquerda, possivelmente com exceção de um único zero antes de um ponto decimal, não são mostrados.

  • Os zeros à direita, possivelmente com exceção de um único zero após um ponto decimal, não são mostrados.

  • Um sinal é mostrado apenas quando o número é negativo.

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.

Booleanos (bool)

Estes representam os valores da verdade Falsos e Verdadeiros. Os dois objetos que representam os valores False e True são os únicos objetos booleanos. O tipo booleano é um subtipo do tipo inteiro, e os valores booleanos se comportam como os valores 0 e 1, respectivamente, em quase todos os contextos, com exceção de que, quando convertidos em uma string, as strings "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.

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 obtidas através dos atributos somente leitura z.real e z.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 por a[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 onde x = 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 tipo char; em vez disso, cada ponto de código na string é representado como um objeto string com comprimento 1. A função embutida ord() converte um ponto de código de sua forma de string para um inteiro no intervalo 0 - 10FFFF; chr() converte um inteiro no intervalo 0 - 10FFFF para o objeto de string correspondente de comprimento 1. str.encode() pode ser usado para converter uma str para bytes usando a codificação de texto fornecida, e bytes.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 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 embutido bytes() podem ser usados para criar objetos bytes. Além disso, os objetos bytes podem ser decodificados em strings através do método decode().

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.)

Vetores 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áveis bytes.

O módulo de extensão array fornece um exemplo adicional de um tipo de sequência mutável, assim como o módulo collections.

Tipos conjuntos

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 e 1.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, como add().

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.

Mapeamentos

Eles representam conjuntos finitos de objetos indexados por conjuntos de índices arbitrários. A notação subscrito a[k] seleciona o item indexado por k do mapeamento a; isso pode ser usado em expressões e como alvo de atribuições ou instruções del. A função embutida len() 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 e 1.0), eles podem ser usados alternadamente para indexar a mesma entrada do dicionário.

Dicionários preservam a ordem de inserção, o que significa que as chaves serão produzidas na mesma ordem em que foram adicionadas sequencialmente no dicionário. Substituir uma chave existente não altera a ordem, no entanto, remover uma chave e inseri-la novamente irá adicioná-la ao final em vez de manter seu lugar anterior.

Os dicionários são mutáveis; eles podem ser criados pela notação {...} (veja a seção Dictionary displays).

Os módulos de extensão dbm.ndbm e dbm.gnu fornecem exemplos adicionais de tipos de mapeamento, assim como o módulo collections.

Alterado na versão 3.7: Dicionários não preservavam a ordem de inserção nas versões do Python anteriores à 3.6. No CPython 3.6, a ordem de inserção foi preservada, mas foi considerada um detalhe de implementação naquela época, em vez de uma garantia de linguagem.

Tipos chamáveis

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__

A string de documentação da função, ou None se indisponível; não herdado por subclasses.

Gravável

__name__

O nome da função.

Gravável

__qualname__

O nome qualificado da função.

Novo na versão 3.3.

Gravável

__module__

O nome do módulo em que a função foi definida ou None se indisponível.

Gravável

__defaults__

Uma tupla contendo valores de argumento padrão para aqueles argumentos que possuem padrões, ou None se nenhum argumento tiver um valor padrão.

Gravável

__code__

O objeto código que representa o corpo da função compilada.

Gravável

__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

__dict__

O espaço de nomes que oferece suporte a atributos de função arbitrários.

Gravável

__closure__

None ou uma tupla de células que contêm ligações para as variáveis livres da função. Veja abaixo as informações sobre o atributo cell_contents.

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.

Gravável

__kwdefaults__

Um dicionário contendo padrões para parâmetros somente-nomeados.

Gravável

A maioria dos atributos rotulados como “Gravável” verifica o tipo do valor atribuído.

Os objetos 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.

Um objeto de célula tem o atributo cell_contents. Isso pode ser usado para obter o valor da célula, bem como definir o valor.

Informações adicionais sobre a definição de uma função podem ser recuperadas de seu objeto de código; veja a descrição dos tipos internos abaixo. O tipo cell pode ser acessado no módulo types.

Instância de métodos

Um objeto método de instância combina uma classe, uma instância de classe e qualquer objeto chamável (normalmente uma função definida pelo usuário).

Atributos especiais somente leitura: __self__ é o objeto de instância da classe, __func__ é o objeto 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, ou None 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 função subjacente.

Os objetos 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 função definido pelo usuário ou um objeto método de classe.

Quando um objeto método de instância é criado recuperando um objeto 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 método é considerado vinculado. O atributo __func__ do novo método é o objeto da função original.

Quando um objeto método de instância é criado recuperando um objeto método de classe de uma classe ou instância, seu atributo __self__ é a própria classe, e seu atributo __func__ é o objeto função subjacente ao método de classe.

Quando um objeto 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, quando C é uma classe que contém uma definição para uma função f(), e x é uma instância de C, chamando x.f(1) é equivalente a chamar C.f(x, 1).

Quando um objeto método de instância é derivado de um objeto método de classe, a “instância de classe” armazenada em __self__ será na verdade a própria classe, de modo que chamar x.f(1) ou C.f(1) é equivalente a chamar f(C,1) sendo f a função subjacente.

Observe que a transformação de objeto função em objeto 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

Uma função ou método que usa a instrução yield (veja a seção The yield statement) é chamada de função geradora. Tal função, quando chamada, sempre retorna um objeto iterador que pode ser usado para executar o corpo da função: chamar o método iterator.__next__() do iterador fará com que a função seja executada até que forneça um valor usando a instrução yield. Quando a função executa uma instrução return ou sai do fim, uma exceção StopIteration é levantada e o iterador terá alcançado o fim do conjunto de valores a serem retornados.

Funções de corrotina

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ões await, bem como instruções async with e async for. Veja também a seção Objetos corrotina.

Funções geradoras assíncronas

Uma função ou um método que é definida(o) usando async def e que usa a instrução yield é 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ção async 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ão yield. Quando a função executa uma instrução vazia return ou cai no final, uma exceção StopAsyncIteration é levantada e o iterador assíncrono terá alcançado o final do conjunto de valores a serem produzidos.

Funções embutidas

Um objeto função embutida é um wrapper em torno de uma função C. Exemplos de funções embutidas são len() e math.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, ou None se indisponível; __name__ é o nome da função; __self__ é definido como None (mas veja o próximo item); __module__ é o nome do módulo no qual a função foi definida ou None se indisponível.

Métodos embutidos

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âncias de classes

Instâncias de classes arbitrárias podem ser tornados chamáveis definindo um método __call__() em sua classe.

Módulos

Módulos são uma unidade organizacional básica do código Python, e são criados pelo sistema de importação como invocado pela instrução import, ou chamando funções como importlib.import_module() e a embutida __import__(). Um objeto de módulo tem um espaço de nomes implementado por um objeto de dicionário (este é o dicionário referenciado pelo atributo __globals__ de funções definidas no módulo). As referências de atributos são traduzidas para pesquisas neste dicionário, por exemplo, m.x é equivalente a m.__dict__["x"]. Um objeto de módulo não contém o objeto código usado para inicializar o módulo (uma vez que não é necessário depois que a inicialização é concluída).

A atribuição de atributo atualiza o dicionário de espaço de nomes do módulo, por exemplo, m.x = 1 é equivalente a m.__dict__["x"] = 1.

Atributos predefinidos (graváveis): __name__ é o nome do módulo; __doc__ é a string de documentação do módulo, ou None 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 para C.__dict__["x"] (embora haja uma série de ganchos que permitem outros meios de localizar atributos) . Quando o nome do atributo não é encontrado lá, a pesquisa do atributo continua nas classes base. Essa pesquisa das classes base usa a ordem de resolução de métodos C3, que se comporta corretamente mesmo na presença de estruturas de herança “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 método de classe, ele é transformado em um objeto método de instância cujo atributo __self__ é C. Quando produziria um objeto método estático, ele é transformado no objeto encapsulado pelo objeto 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, ou None se indefinido; __annotations__ (opcional) é um dicionário contendo anotações de variáveis coletadas durante a execução do corpo da classe.

Instâncias de classe

Uma instância de classe é criada chamando um objeto classe (veja acima). Uma instância de classe tem um espaço de nomes implementado como um dicionário que é o primeiro lugar no qual as referências de atributos são pesquisadas. Quando um atributo não é encontrado lá, e a classe da instância possui um atributo com esse nome, a pesquisa continua com os atributos da classe. Se for encontrado um atributo de classe que seja um objeto função definido pelo usuário, ele é transformado em um objeto método de instância cujo atributo __self__ é a instância. Métodos estáticos e objetos 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 arquivo representa um arquivo aberto. Vários atalhos estão disponíveis para criar objetos arquivos: a função embutida open(), e também os.popen(), os.fdopen() e o método makefile() 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 e sys.stderr são inicializados para objetos arquivo que correspondem aos fluxos de entrada, saída e erro padrão do interpretador; eles são todos abertos em modo texto e, portanto, seguem a interface definida pela classe abstrata io.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.

Objetos 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.

Atributos especiais de somente leitura: co_name fornece o nome da função; co_argcount é o número total de argumentos posicionais (incluindo argumentos apenas posicionais e argumentos com valores padrão); co_posonlyargcount é o número de argumentos somente-posicionais (incluindo argumentos com valores padrão); co_kwonlyargcount é o número de argumentos somente-nomeados (incluindo argumentos com valores padrão); co_nlocals é o número de variáveis ​​locais usadas pela função (incluindo argumentos); co_varnames é uma tupla contendo os nomes das variáveis ​​locais (começando com os nomes dos argumentos); co_cellvars é uma tupla contendo os nomes das variáveis ​​locais que são referenciadas por funções aninhadas; co_freevars é uma tupla contendo os nomes das variáveis ​​livres; co_code é uma string que representa a sequência de instruções de bytecode; co_consts é uma tupla contendo os literais usados ​​pelo bytecode; co_names é uma tupla contendo os nomes usados ​​pelo bytecode; co_filename é o nome do arquivo a partir do qual o código foi compilado; co_firstlineno é o número da primeira linha da função; co_lnotab é uma string que codifica o mapeamento de deslocamentos de bytecode para números de linha (para detalhes, veja o código-fonte do interpretador); co_stacksize é o tamanho de pilha necessário; co_flags é um inteiro que codifica uma série de sinalizadores para o interpretador.

Os seguintes bits de sinalizador são definidos para co_flags: o bit 0x04 é definido se a função usa a sintaxe *arguments para aceitar um número arbitrário de argumentos posicionais; o bit 0x08 é definido se a função usa a sintaxe **keywords para aceitar argumentos nomeados arbitrários; o bit 0x20 é definido se a função for um gerador.

Declarações de recursos futuros (from __future__ import division) também usam bits em co_flags para indicar se um objeto código foi compilado com um recurso específico habilitado: o bit 0x2000 é definido se a função foi compilada com divisão futura habilitada; os bits 0x10 e 0x1000 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, ou None se indefinido.

Objetos quadro

Objetos quadro representam quadros de execução. Eles podem ocorrer em objetos traceback (veja abaixo) e também são passados para funções de rastreamento registradas.

Atributos especiais de somente leitura: f_back é para o quadro de pilha anterior (para o chamador), ou None 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).

Atributos especiais de escrita: f_trace, se não None, é uma função chamada para vários eventos durante a execução do código (isso é usado pelo depurador). Normalmente, um evento é disparado para cada nova linha de origem – isso pode ser desabilitado configurando f_trace_lines para False.

As implementações podem permitir que eventos por opcode sejam solicitados definindo f_trace_opcodes para True. Observe que isso pode levar a um comportamento indefinido do interpretador se as exceções levantadas pela função trace escaparem à função que está sendo rastreada.

f_lineno é o número da linha atual do quadro – escrever nele a partir de uma função de rastreamento salta para a linha fornecida (apenas para o quadro mais abaixo). Um depurador pode implementar um comando Jump (também conhecido como Set Next Statement) escrevendo para 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

Objetos traceback representam um stack trace (situação da pilha de execução) de uma exceção. Um objeto traceback é criado implicitamente quando ocorre uma exceção e também pode ser criado explicitamente chamando types.TracebackType.

Para tracebacks criados implicitamente, quando a busca por um manipulador de exceção desenrola a pilha de execução, em cada nível desenrolado um objeto traceback é inserido na frente do traceback atual. Quando um manipulador de exceção é inserido, o stack trace é disponibilizado para o programa. (Veja a seção The try statement.) É acessível como o terceiro item da tupla retornada por sys.exc_info(), e como o atributo __traceback__ da exceção capturada.

Quando o programa não contém um manipulador adequado, o stack trace é escrito (formatado de maneira adequada) no fluxo de erro padrão; se o interpretador for interativo, ele também é disponibilizado ao usuário como sys.last_traceback.

Para tracebacks criados explicitamente, cabe ao criador do traceback determinar como os atributos tb_next devem ser vinculados para formar um stack trace completo.

Atributos especiais de somente leitura: tb_frame aponta para o quadro de execução do nível atual; tb_lineno fornece o número da linha onde ocorreu a exceção; tb_lasti indica a instrução precisa. O número da linha e a última instrução no traceback podem diferir do número da linha de seu objeto quadro se a exceção ocorreu em uma instrução try sem cláusula except correspondente ou com uma cláusula finally.

Atributo especial de escrita: tb_next é o próximo nível no stack trace (em direção ao quadro onde a exceção ocorreu), ou None se não houver próximo nível.

Alterado na versão 3.7: Os objetos traceback agora podem ser explicitamente instanciados a partir do código Python, e o atributo tb_next das instâncias existentes pode ser atualizado.

Objetos slice

Objetos slice são usados para representar fatias para métodos __getitem__(). Eles também são criados pela função embutida slice().

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 método de classe após tal recuperação é descrito acima, em “Métodos definidos pelo usuário”. Objetos 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. Personalizaçã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 usando super().__new__(cls[, ...]) com os argumentos apropriados e, em seguida, modificando a instância recém-criada conforme necessário antes de retorná-la.

Se __new__() é chamado durante a construção do objeto e retorna uma instância ou subclasse de cls, então o método __init__() da nova instância será chamado como __init__(self[, ...]), onde self é a nova instância e os argumentos restantes são os mesmos que foram passados para o construtor do objeto.

Se __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 __init__() trabalham juntos na construção de objetos (__new__() para criá-lo e __init__() para personalizá-lo), nenhum valor diferente de None pode ser retornado por __init__(); fazer isso fará com que uma TypeError 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 diretamente x.__del__() – o primeiro diminui a contagem de referências para x em um, e o segundo só é chamado quando a contagem de referências de x 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 em sys.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 como None. 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 embutidas format() e print() para calcular a representação da string “informal” ou agradável para exibição de um objeto. O valor de retorno deve ser um objeto 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 chama object.__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)

Chamado pela função embutida format() e, por extensão, avaliação de literais de string formatadas e o método str.format(), para produzir uma representação de string “formatada” de um objeto. O argumento format_spec é uma string que contém uma descrição das opções de formatação desejadas. A interpretação do argumento format_spec depende do tipo que implementa __format__(), entretanto a maioria das classes delegará a formatação a um dos tipos embutidos ou usará uma sintaxe de opção de formatação semelhante.

Consulte Format Specification Mini-Language 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 uma TypeError se passada qualquer string não vazia.

Alterado na versão 3.7: object.__format__(x, '') é agora equivalente a str(x) em vez de format(str(x), '').

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 chama x.__lt__(y), x<=y chama x.__le__(y), x==y chama x.__eq__(y), x!=y chama x.__ne__(y), x>y chama x.__gt__(y) e x>=y chama x.__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 e True são retornados para uma comparação bem-sucedida. No entanto, esses métodos podem retornar qualquer valor, portanto, se o operador de comparação for usado em um contexto booleano (por exemplo, na condição de uma instrução if), Python irá chamar bool() no valor para determinar se o resultado for verdadeiro ou falso.

Por padrão, object implementa __eq__() usando is, retornando NotImplemented no caso de uma comparação falsa: True if x is y else NotImplemented. Para __ne__(), por padrão ele delega para __eq__() e inverte o resultado a menos que seja NotImplemented. Não há outras relações implícitas entre os operadores de comparação ou implementações padrão; por exemplo, a verdade de (x<y or x==y) não implica x<=y. Para gerar operações de ordenação automaticamente a partir de uma única operação raiz, consulte functools.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 incluindo set, frozenset e dict. __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 um Py_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 é com python -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) e x.__hash__() retorna um valor apropriado tal que x == y implica que x is y e hash(x) == hash(y).

Uma classe que sobrescreve __eq__() e não define __hash__() terá seu __hash__() implicitamente definido como None. Quando o método __hash__() de uma classe é None, as instâncias da classe levantam uma TypeError apropriada quando um programa tenta recuperar seu valor hash, e também será identificado corretamente como inalterável ao verificar isinstance(obj, collections.abc.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__.

Se uma classe que não substitui __eq__() deseja suprimir o suporte a hash, deve incluir __hash__ = None na definição de classe. Uma classe que define seu próprio __hash__() que levanta explicitamente uma TypeError seria incorretamente identificada como hasheável por uma chamada isinstance(obj, collections.abc.Hashable).

Nota

Por padrão, os valores __hash__() dos objetos str e bytes são “salgados” com um valor aleatório imprevisível. Embora permaneçam constantes em um processo individual do Python, eles não são previsíveis entre invocações repetidas do Python.

Isso se destina a fornecer proteção contra uma negação de serviço causada por entradas cuidadosamente escolhidas que exploram o pior caso de desempenho de uma inserção de dicionário, complexidade O(n^2). Consulte http://www.ocert.org/advisories/ocert-2011-003.html para obter detalhes.

Alterar os valores de hash afeta a ordem de iteração dos conjuntos. Python nunca deu garantias sobre essa ordem (e normalmente varia entre compilações de 32 e 64 bits).

Consulte também 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 retornar False ou True. 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 uma AttributeError porque name não é um atributo de instância ou um atributo na árvore de classes para self; ou __get__() de uma propriedade name levanta AttributeError). Este método deve retornar o valor do atributo (calculado) ou levantar uma exceção AttributeError.

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 um AttributeError. Este método deve retornar o valor do atributo (calculado) ou levantar uma exceção AttributeError. Para evitar recursão infinita neste método, sua implementação deve sempre chamar o método da classe base com o mesmo nome para acessar quaisquer atributos de que necessita, por exemplo, 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.

Levanta um evento de auditoria object.__getattr__ com argumentos obj, name.

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).

Levanta um evento de auditoria object.__setattr__ com argumentos obj, name, value.

object.__delattr__(self, name)

Como __setattr__(), mas para exclusão de atributo em vez de atribuição. Isso só deve ser implementado se del obj.name for significativo para o objeto.

Levanta um evento de auditoria object.__delattr__ com argumentos obj, name.

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

Os nomes especiais __getattr__ e __dir__ também podem ser usados para personalizar o acesso aos atributos dos módulos. A função __getattr__ no nível do módulo deve aceitar um argumento que é o nome de um atributo e retornar o valor calculado ou levantar um AttributeError. Se um atributo não for encontrado em um objeto de módulo por meio da pesquisa normal, por exemplo object.__getattribute__(), então __getattr__ é pesquisado no módulo __dict__ antes de levantar um AttributeError . Se encontrado, ele é chamado com o nome do atributo e o resultado é retornado.

A função __dir__ não deve aceitar nenhum argumento e retornar uma sequência de strings que representa os nomes acessíveis no módulo. Se presente, esta função substitui a pesquisa padrão dir() em um módulo.

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}...')
        super().__setattr__(attr, value)

sys.modules[__name__].__class__ = VerboseModule

Nota

Definir o módulo __getattr__ e configurar o módulo __class__ só afeta as pesquisas feitas usando a sintaxe de acesso ao atributo – acessar diretamente os globais do módulo (seja por código dentro do módulo, ou por meio de uma referência ao dicionário global do módulo) é não afetado.

Alterado na versão 3.5: O atributo de módulo __class__ pode agora ser escrito.

Novo na versão 3.7: Atributos de módulo __getattr__ e __dir__.

Ver também

PEP 562 - __getattr__ e __dir__ de módulo

Descreve as funções __getattr__ e __dir__ nos módulos.

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=None)

Chamado para obter o atributo da classe proprietária (acesso ao atributo da classe) ou de uma instância dessa classe (acesso ao atributo da instância). O argumento opcional owner é a classe proprietária, enquanto instance é a instância pela qual o atributo foi acessado, ou None quando o atributo é acessado por meio de owner.

Este método deve retornar o valor do atributo calculado ou levantar uma exceção AttributeError.

PEP 252 especifica que __get__() é um chamável com um ou dois argumentos. Os próprios descritores embutidos do Python suportam esta especificação; no entanto, é provável que algumas ferramentas de terceiros tenham descritores que requerem ambos os argumentos. A implementação de __getattribute__() do próprio Python sempre passa em ambos os argumentos sejam eles requeridos ou não.

object.__set__(self, instance, value)

Chamado para definir o atributo em uma instância instance da classe proprietária para um novo valor, value.

Observe que adicionar __set__() ou __delete__() altera o tipo de descritor para um “descritor de dados”. Consulte Invocando descritores para mais detalhes.

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.

Nota

__set_name__() só é chamado implicitamente como parte do construtor type, então ele precisará ser chamado explicitamente com os parâmetros apropriados quando um descritor é adicionado a uma classe após a criação inicial:

class A:
   pass
descr = custom_descriptor()
A.attr = descr
descr.__set_name__(A, 'attr')

Consulte Criando o objeto da classe para mais detalhes.

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. Invocando descritores

Em geral, um descritor é um atributo de objeto com “comportamento de ligação”, cujo acesso ao atributo foi substituído por métodos no protocolo do descritor: __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 de super, então a ligação super(B, obj).m() procura obj.__class__.__mro__ para a classe base A precedendo imediatamente B e, em seguida, invoca o descritor com a chamada: A.__dict__['m'].__get__(obj, obj.__class__).

Para ligações de instâncias, a precedência de invocação do descritor depende de quais métodos do descritor são definidos. Um descritor pode definir qualquer combinação de __get__(), __set__() e __delete__(). Se ele não definir __get__(), então acessar o atributo retornará o próprio objeto descritor, a menos que haja um valor no dicionário de instância do objeto. Se o descritor define __set__() e/ou __delete__(), é um descritor de dados; se não definir nenhum, é um descritor sem dados. Normalmente, os descritores de dados definem __get__() e __set__(), enquanto os descritores sem dados têm apenas o método __get__(). Descritores de dados com __get__() e __set__() (e/ou __delete__()) definidos sempre substituem uma redefinição em um dicionário de instância. Em contraste, descritores sem dados podem ser substituídos por instâncias.

Os métodos Python (incluindo 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.)

O espaço economizado com o uso de __dict__ pode ser significativo. A velocidade de pesquisa de atributos também pode ser significativamente melhorada.

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 e tuple.

  • 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.

  • Se um iterador for usado para __slots__, um descritor é criado para cada um dos valores do iterador. No entanto, o atributo __slots__ será um iterador vazio.

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 como type(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:

  • Entradas de MRO são resolvidas;

  • a metaclasse apropriada é determinada;

  • o espaço de nomes da classe é preparada;

  • o corpo da classe é executado;

  • o objeto da classe é criado.

3.3.3.2. Resolvendo entradas de MRO

Se uma base que aparece na definição de classe não é uma instância de type, então um método __mro_entries__ é pesquisado nela. Se encontrado, ele é chamado com a tupla de base original. Este método deve retornar uma tupla de classes que serão usadas no lugar desta base. A tupla pode estar vazia, neste caso a base original é ignorada.

Ver também

PEP 560 - Suporte básico para inserir módulo e tipos genéricos

3.3.3.3. Determinando a metaclasse apropriada

A metaclasse apropriada para uma definição de classe é determinada da seguinte forma:

  • se nenhuma base e nenhuma metaclasse explícita forem fornecidas, então type() é usada;

  • se uma metaclasse explícita é fornecida e não é uma instância de type(), então ela é usada diretamente como a metaclasse;

  • se uma instância de type() é fornecida como a metaclasse explícita, ou bases são definidas, então a metaclasse mais derivada é usada.

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.4. Preparando o espaço de nomes da classe

Assim que a metaclasse apropriada for identificada, o espaço de nomes da classe é preparado. Se a metaclasse tem um atributo __prepare__, ela é chamada de namespace = metaclass.__prepare__(name, bases, **kwds) (onde os argumentos nomeados adicionais, se houver, vêm da definição de classe) . O método __prepare__ deve ser implementado como uma classmethod(). O espaço de nomes retornado por __prepare__ é passado para __new__, mas quando o objeto final da classe é criado, o espaço de nomes é copiado para um novo dict.

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.5. 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.6. 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: No CPython 3.6 e posterior, a célula __class__ é passada para a metaclasse como uma entrada de __classcell__ no espaço de nomes da classe. Se estiver presente, deve ser propagado até a chamada type.__new__ para que a classe seja inicializada corretamente. Não fazer isso resultará em um RuntimeError no 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__();

  • segundo, todos esses métodos __set_name__ são chamados com a classe sendo definida e o nome atribuído daquele descritor particular;

  • finalmente, 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.7. 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 - Introduzindo classes base abstratas

Inclui a especificação para personalizar o comportamento de isinstance() e issubclass() através de __instancecheck__() e __subclasscheck__(), com motivação para esta funcionalidade no contexto da adição de classes base abstratas (veja o módulo abc) para a linguagem.

3.3.5. Emulando tipos genéricos

Pode-se implementar a sintaxe de classe genérica conforme especificado por PEP 484 (por exemplo, List[int]) definindo um método especial:

classmethod object.__class_getitem__(cls, key)

Retorna um objeto que representa a especialização de uma classe genérica por argumentos de tipo encontrados em key.

Esse método é pesquisado no próprio objeto classe e, quando definido no corpo da classe, esse método é implicitamente um método de classe. Observe que esse mecanismo é reservado principalmente para uso com dicas de tipo estático; outro uso é desencorajado.

Ver também

PEP 560 - Suporte básico para inserir módulo e tipos genéricos

3.3.6. 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, ...) basicamente traduz para type(x).__call__(x, arg1, ...).

3.3.7. Emulando de tipos contêineres

Os métodos a seguir podem ser definidos para implementar objetos contêineres. Os contêineres geralmente são sequências (como listas ou tuplas) ou mapeamentos (como dicionários), mas também podem representar outros contêineres. O primeiro conjunto de métodos é usado para emular uma sequência ou para emular um mapeamento; a diferença é que, para uma sequência, as chaves permitidas devem ser os inteiros k para os quais 0 <= k < N onde N é o comprimento da sequência, ou objetos fatia, que definem um intervalo de itens. Também é recomendado que os mapeamentos forneçam os métodos keys(), values(), items(), get(), clear(), setdefault(), pop(), popitem(), copy() e update() se comportando de forma semelhante aos objetos dicionário padrão do Python. O módulo Collections.abc fornece uma classe base abstrata MutableMapping para ajudar a criar esses métodos a partir de um conjunto base de __getitem__(), __setitem__(), __delitem__() e keys(). Sequências mutáveis ​​devem fornecer métodos append(), count(), index(), extend(), insert(), pop(), remove(), reverse() e sort(), como objetos lista padrão do Python. Finalmente, os tipos de sequência devem implementar adição (significando concatenação) e multiplicação (significando repetição) definindo os métodos __add__(), __radd__(), __iadd__(), __mul__(), __rmul__() e __imul__() descritos abaixo; eles não devem definir outros operadores numéricos. É recomendado que ambos os mapeamentos e sequências implementem o método __contains__() para permitir o uso eficiente do operador in; para mapeamentos, in deve pesquisar as chaves do mapeamento; para sequências, ele deve pesquisar os valores. É ainda recomendado que ambos os mapeamentos e sequências implementem o método __iter__() para permitir a iteração eficiente através do contêiner; para mapeamentos, __iter__() deve iterar através das chaves do objeto; para sequências, ele deve iterar por meio dos valores.

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 que sys.maxsize, alguns recursos (como len()) podem levantar OverflowError. Para evitar levantar OverflowError pelo teste de valor de verdade, um objeto deve definir um método __bool__().

object.__length_hint__(self)

Chamado para implementar operator.length_hint(). Deve retornar um comprimento estimado para o objeto (que pode ser maior ou menor que o comprimento real). O comprimento deve ser um inteiro >= 0. O valor de retorno também pode ser NotImplemented, que é tratado da mesma forma como se o método __length_hint__ não existisse. Este método é puramente uma otimização e nunca é necessário para a correção.

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 uma IndexError 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 implementar self[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, o reversed() 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 por reversed().

Os operadores de teste de associação (in e not in) são normalmente implementados como uma iteração através de um contêiner. No entanto, os objetos contêiner podem fornecer o seguinte método especial com uma implementação mais eficiente, que também não requer que o objeto seja iterável.

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.8. 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ão x + 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 interna pow() 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[, modulo])
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ão x - y, onde y é uma instância de uma classe que tem um método __rsub__(), y.__rsub__(x) é chamado se x.__sub__(y) retorna NotImplemented.

Note que ternário pow() não tentará chamar __rpow__() (as regras de coerção se tornariam muito complicadas).

Nota

Se o tipo do operando direito for uma subclasse do tipo do operando esquerdo e essa subclasse fornecer uma implementação diferente do método refletido para a operação, este método será chamado antes do método não refletido do operando esquerdo. Esse comportamento permite que as subclasses substituam as operações de seus ancestrais.

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 a x = x.__iadd__(y). Caso contrário, x.__add__(y) e y.__radd__(x) são considerados, como com a avaliação de x + 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.

Nota

Devido a um bug no mecanismo de despacho para **=, uma classe que define __ipow__() mas retorna NotImplemented não voltaria para x.__pow__(y) e y.__rpow__(x). Este bug foi corrigido no Python 3.10.

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() e float(). 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 embutidas bin(), hex() e oct()). A presença deste método indica que o objeto numérico é do tipo inteiro. Deve retornar um número inteiro.

Se __int__(), __float__() e __complex__() não estiverem definidos, funções embutidas correspondentes int(), float() e complex() recorre a __index__().

object.__round__(self[, ndigits])
object.__trunc__(self)
object.__floor__(self)
object.__ceil__(self)

Chamado para implementar as funções embutidas round() e trunc(), floor() e ceil() de math. A menos que ndigits sejam passados para __round__() todos estes métodos devem retornar o valor do objeto truncado para um Integral (tipicamente um int).

Se __int__() não for definido, então a função embutida int() retrocede para __trunc__().

3.3.9. Com gerenciadores de contexto de instruções

Um gerenciador de contexto é um objeto que define o contexto de tempo de execução a ser estabelecido ao executar uma instrução with. O gerenciador de contexto lida com a entrada e a saída do contexto de tempo de execução desejado para a execução do bloco de código. Os gerenciadores de contexto são normalmente invocados usando a instrução with (descrita na seção The with statement), mas também podem ser usados invocando diretamente seus métodos.

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)

Insere o contexto de tempo de execução relacionado a este objeto. A instrução with vinculará o valor de retorno deste método ao(s) alvo(s) especificado(s) na cláusula as da instrução, se houver.

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.

Ver também

PEP 343 - A instrução “with”

A especificação, o histórico e os exemplos para a instrução Python with.

3.3.10. 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. Corrotinas

3.4.1. Objetos aguardáveis

Um objeto aguardável geralmente implementa um método __await__(). Os objetos corrotina retornados das funções async def são aguardáveis.

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ão await.

Novo na versão 3.5.

Ver também

PEP 492 para informações adicionais sobre objetos aguardáveis.

3.4.2. Objetos corrotina

Objetos corrotina são objetos aguardáveis. A execução de uma corrotina pode ser controlada chamando __await__() e iterando sobre o resultado. Quando a corrotina termina a execução e retorna, o iterador levanta StopIteration, e o atributo value da exceção contém o valor de retorno. Se a corrotina levantar uma exceção, ela será propagada pelo iterador. As corrotinas não devem levantar exceções StopIteration diretamente não tratadas.

As corrotinas também têm os métodos listados abaixo, que são análogos aos dos geradores (ver 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 for None, este método delega para o método send() 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 levanta GeneratorExit no ponto de suspensão, fazendo com que a corrotina se limpe imediatamente. Por fim, a corrotina é marcada como tendo sua execução concluída, mesmo que nunca tenha sido iniciada.

Objetos corrotina são fechados automaticamente usando o processo acima quando estão prestes a ser destruídos.

3.4.3. Iteradores assíncronos

Um iterador assíncrono pode chamar código assíncrono em seu método __anext__.

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 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.

Alterado na versão 3.7: Antes do Python 3.7, __aiter__ poderia retornar um aguardável que resolveria para um iterador assíncrono.

A partir do Python 3.7, __aiter__ deve retornar um objeto iterador assíncrono. Retornar qualquer outra coisa resultará em um erro TypeError.

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)

Semanticamente semelhante a __enter__(), a única diferença é que ele deve retornar um aguardável.

object.__aexit__(self, exc_type, exc_value, traceback)

Semanticamente semelhante a __exit__(), a única diferença é que ele deve retornar um aguardável.

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 um TypeError, mas podem fazer isso contando com o comportamento de que None 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 como None se quiser forçar o fallback para o método refletido do operando correto – isso terá o efeito oposto de bloquear explicitamente esse fallback.

4

Para operandos do mesmo tipo, presume-se que se o método não refletido – como __add__() – falhar, a operação geral não será suportada, razão pela qual o método refletido não é chamado.