Classes - Documentação Python 3.12.3
Classes - Documentação Python 3.12.3
Classes
Classes proporcionam uma forma de organizar dados e funcionalidades juntos. Criar uma
nova classe cria um novo “tipo” de objeto, permitindo que novas “instâncias” desse tipo
sejam produzidas. Cada instância da classe pode ter atributos anexados a ela, para man-
ter seu estado. Instâncias da classe também podem ter métodos (definidos pela classe)
para modificar seu estado.
Usando a terminologia de C++, todos os membros de uma classe (incluindo dados) são
públicos (veja exceção abaixo Variáveis privadas), e todos as funções membro são virtu-
ais. Como em Modula-3, não existem atalhos para referenciar membros do objeto de
dentro dos seus métodos: o método (função definida em uma classe) é declarado com
um primeiro argumento explícito representando o objeto (instância da classe), que é for-
necido implicitamente pela chamada ao método. Como em Smalltalk, classes são obje-
tos. Isso fornece uma semântica para importar e renomear. Ao contrário de C++ ou Mo-
dula-3, tipos pré-definidos podem ser utilizados como classes base para extensões por
herança pelo usuário. Também, como em C++, a maioria dos operadores (aritméticos,
indexação, etc) podem ser redefinidos por instâncias de classe.
(Na falta de uma terminologia universalmente aceita para falar sobre classes, ocasional-
mente farei uso de termos comuns em Smalltalk ou C++. Eu usaria termos de Modula-3,
já que sua semântica de orientação a objetos é mais próxima da de Python, mas creio
que poucos leitores já ouviram falar dessa linguagem.)
A propósito, utilizo a palavra atributo para qualquer nome depois de um ponto. Na ex-
pressão z.real , por exemplo, real é um atributo do objeto z . Estritamente falando,
referências para nomes em módulos são atributos: na expressão modname.funcname ,
modname é um objeto módulo e funcname é um de seus atributos. Neste caso, existe um
mapeamento direto entre os atributos de um módulo e os nomes globais definidos no
módulo: eles compartilham o mesmo espaço de nomes! [1]
Atributos podem ser somente leitura ou para leitura e escrita. No segundo caso, é possí-
vel atribuir um novo valor ao atributo. Atributos de módulos são passíveis de atribuição:
você pode escrever modname.the_answer = 42 . Atributos que aceitam escrita tam-
bém podem ser apagados através da instrução del . Por exemplo, del
modname.the_answer removerá o atributo the_answer do objeto referenciado por
modname .
O espaço de nomes local de uma função é criado quando a função é invocada, e apaga-
do quando a função retorna ou levanta uma exceção que não é tratada na própria função.
(Na verdade, uma forma melhor de descrever o que realmente acontece é que o espaço
de nomes local é “esquecido” quando a função termina.) Naturalmente, cada invocação
recursiva de uma função tem seu próprio espaço de nomes.
Ainda que escopos sejam determinados estaticamente, eles são usados dinamicamente.
A qualquer momento durante a execução, existem 3 ou 4 escopos aninhados cujos espa-
ços de nomes são diretamente acessíveis:
É importante perceber que escopos são determinados estaticamente, pelo texto do códi-
go-fonte: o escopo global de uma função definida em um módulo é o espaço de nomes
deste módulo, sem importar de onde ou por qual apelido a função é invocada. Por outro
lado, a busca de nomes é dinâmica, ocorrendo durante a execução. Porém, a evolução
da linguagem está caminhando para uma resolução de nomes estática, em “tempo de
compilação”, portanto não conte com a resolução dinâmica de nomes! (De fato, variáveis
locais já são resolvidas estaticamente.)
A instrução global pode ser usada para indicar que certas variáveis residem no escopo
global ao invés do local; a instrução nonlocal indica que variáveis particulares estão em
um espoco mais interno e devem ser recuperadas lá.
Este é um exemplo que demonstra como se referir aos diferentes escopos e aos espaços
de nomes, e como global e nonlocal pode afetar ligação entre as variáveis:
def scope_test():
def do_local():
spam = "local spam"
def do_nonlocal():
nonlocal spam
spam = "nonlocal spam"
def do_global():
global spam
spam = "global spam"
scope_test()
print("In global scope:", spam)
Observe como uma atribuição local (que é o padrão) não altera o vínculo de scope_test a
spam. A instrução nonlocal mudou o vínculo de scope_test de spam e a atribuição
global alterou a ligação para o nível do módulo.
Você também pode ver que não havia nenhuma ligação anterior para spam antes da atri-
buição global .
class ClassName:
<statement-1>
.
.
.
<statement-N>
Definições de classe, assim como definições de função (instruções def ), precisam ser
executadas antes que tenham qualquer efeito. (Você pode colocar uma definição de
classe dentro do teste condicional de um if ou dentro de uma função.)
Quando uma definição de classe é finalizada normalmente (até o fim), um objeto classe é
criado. Este objeto encapsula o conteúdo do espaço de nomes criado pela definição da
classe; aprenderemos mais sobre objetos classe na próxima seção. O escopo local (que
estava vigente antes da definição da classe) é reativado, e o objeto classe é vinculado ao
identificador da classe nesse escopo ( ClassName no exemplo).
Referências a atributos de classe utilizam a sintaxe padrão utilizada para quaisquer refe-
rências a atributos em Python: obj.nome . Nomes de atributos válidos são todos os no-
mes presentes dentro do espaço de nomes da classe, quando o objeto classe foi criado.
Portanto, se a definição de classe tem esta forma:
class MyClass:
"""A simple example class"""
i = 12345
def f(self):
return 'hello world'
Para instanciar uma classe, usa-se a mesma sintaxe de invocar uma função. Apenas finja
que o objeto classe do exemplo é uma função sem parâmetros, que devolve uma nova
instância da classe. Por exemplo (assumindo a classe acima):
x = MyClass()
cria uma nova instância da classe e atribui o objeto resultante à variável local x .
A operação de instanciação (“invocar” um objeto classe) cria um objeto vazio. Muitas
classes preferem criar novos objetos com um estado inicial predeterminado. Para tanto, a
classe pode definir um método especial chamado __init__() , assim:
def __init__(self):
self.data = []
x = MyClass()
Naturalmente, o método __init__() pode ter parâmetros para maior flexibilidade. Nes-
te caso, os argumentos fornecidos na invocação da classe serão passados para o méto-
do __init__() . Por exemplo,
Agora o que podemos fazer com objetos de instância? As únicas operações compreendi-
das por objetos de instância são os atributos de referência. Existem duas maneiras váli-
das para nomear atributos: atributos de dados e métodos.
x.counter = 1
while x.counter < 10:
x.counter = x.counter * 2
print(x.counter)
del x.counter
O outro tipo de referências a atributos de instância é o “método”. Um método é uma fun-
ção que “pertence” a um objeto instância. (Em Python, o termo método não é aplicado
exclusivamente a instâncias de classes definidas pelo usuário: outros tipos de objetos
também podem ter métodos. Por exemplo, listas possuem os métodos append, insert,
remove, sort, entre outros. Porém, na discussão a seguir, usaremos o termo método ape-
nas para se referir a métodos de classes definidas pelo usuário. Seremos explícitos ao
falar de outros métodos.)
Nomes de métodos válidos de uma instância dependem de sua classe. Por definição,
cada atributo de uma classe que é uma função corresponde a um método das instâncias.
Em nosso exemplo, x.f é uma referência de método válida já que MyClass.f é uma
função, enquanto x.i não é, já que MyClass.i não é uma função. Entretanto, x.f não é
o mesmo que MyClass.f . A referência x.f acessa um objeto método e a MyClass.f
acessa um objeto função.
x.f()
xf = x.f
while True:
print(xf())
O que ocorre precisamente quando um método é invocado? Você deve ter notado que
x.f() foi chamado sem nenhum argumento, porém a definição da função f() especifi-
cava um argumento. O que aconteceu com esse argumento? Certamente Python levanta
uma exceção quando uma função que declara um argumento é invocada sem nenhum
argumento — mesmo que o argumento não seja usado no corpo da função…
De forma geral, variáveis de instância são variáveis que indicam dados que são únicos a
cada instância individual, e variáveis de classe são variáveis de atributos e de métodos
que são comuns a todas as instâncias de uma classe:
class Dog:
>>> d = Dog('Fido')
>>> e = Dog('Buddy')
>>> d.kind # shared by all dogs
'canine'
>>> e.kind # shared by all dogs
'canine'
>>> d.name # unique to d
'Fido'
>>> e.name # unique to e
'Buddy'
Como vimos em Uma palavra sobre nomes e objetos, dados compartilhados podem cau-
sar efeitos inesperados quando envolvem objetos (mutáveis), como listas ou dicionários.
Por exemplo, a lista tricks do código abaixo não deve ser usada como variável de classe,
pois assim seria compartilhada por todas as instâncias de Dog:
class Dog:
>>> d = Dog('Fido')
>>> e = Dog('Buddy')
>>> d.add_trick('roll over')
>>> e.add_trick('play dead')
>>> d.tricks # unexpectedly shared by all dogs
['roll over', 'play dead']
Em vez disso, o modelo correto da classe deve usar uma variável de instância:
class Dog:
>>> d = Dog('Fido')
>>> e = Dog('Buddy')
>>> d.add_trick('roll over')
>>> e.add_trick('play dead')
>>> d.tricks
['roll over']
>>> e.tricks
['play dead']
Atributos de dados podem ser referenciados por métodos da própria instância, bem
como por qualquer outro usuário do objeto (também chamados “clientes” do objeto). Em
outras palavras, classes não servem para implementar tipos puramente abstratos de da-
dos. De fato, nada em Python torna possível assegurar o encapsulamento de dados —
tudo é baseado em convenção. (Por outro lado, a implementação de Python, escrita em
C, pode esconder completamente detalhes de um objeto e controlar o acesso ao objeto,
se necessário; isto pode ser utilizado por extensões de Python escritas em C.)
Clientes devem utilizar atributos de dados com cuidado, pois podem bagunçar invarian-
tes assumidas pelos métodos ao esbarrar em seus atributos de dados. Note que clientes
podem adicionar atributos de dados a suas próprias instâncias, sem afetar a validade dos
métodos, desde que seja evitado o conflito de nomes. Novamente, uma convenção de
nomenclatura poupa muita dor de cabeça.
Não existe atalho para referenciar atributos de dados (ou outros métodos!) de dentro de
um método. Isso aumenta a legibilidade dos métodos: não há como confundir variáveis
locais com variáveis da instância quando lemos rapidamente um método.
Qualquer objeto função que é atributo de uma classe, define um método para as instân-
cias dessa classe. Não é necessário que a definição da função esteja textualmente em-
butida na definição da classe. Atribuir um objeto função a uma variável local da classe é
válido. Por exemplo:
class C:
f = f1
def g(self):
return 'hello world'
h = g
class Bag:
def __init__(self):
self.data = []
Métodos podem referenciar nomes globais da mesma forma que funções comuns. O es-
copo global associado a um método é o módulo contendo sua definição na classe (a
classe propriamente dita nunca é usada como escopo global!). Ainda que seja raro justifi-
car o uso de dados globais em um método, há diversos usos legítimos do escopo global.
Por exemplo, funções e módulos importados no escopo global podem ser usados por
métodos, bem como as funções e classes definidas no próprio escopo global. Provavel-
mente, a classe contendo o método em questão também foi definida neste escopo glo-
bal. Na próxima seção veremos razões pelas quais um método pode querer referenciar
sua própria classe.
Cada valor é um objeto e, portanto, tem uma classe (também chamada de tipo). Ela é ar-
mazenada como object.__class__ .
9.5. Herança
Obviamente, uma característica da linguagem não seria digna do nome “classe” se não
suportasse herança. A sintaxe para uma classe derivada é assim:
class DerivedClassName(BaseClassName):
<statement-1>
.
.
.
<statement-N>
A execução de uma definição de classe derivada procede da mesma forma que a de uma
classe base. Quando o objeto classe é construído, a classe base é lembrada. Isso é utili-
zado para resolver referências a atributos. Se um atributo requisitado não for encontrado
na classe, ele é procurado na classe base. Essa regra é aplicada recursivamente se a
classe base por sua vez for derivada de outra.
Classes derivadas podem sobrescrever métodos das suas classes base. Uma vez que
métodos não possuem privilégios especiais quando invocam outros métodos no mesmo
objeto, um método na classe base que invoca um outro método da mesma classe base
pode, efetivamente, acabar invocando um método sobreposto por uma classe derivada.
(Para programadores C++ isso significa que todos os métodos em Python são realmente
virtuais .)
Um método sobrescrito em uma classe derivada, de fato, pode querer estender, em vez
de simplesmente substituir, o método da classe base, de mesmo nome. Existe uma ma-
neira simples de chamar diretamente o método da classe base: apenas chame
BaseClassName.methodname(self, arguments) . Isso é geralmente útil para os cli-
entes também. (Note que isto só funciona se a classe base estiver acessível como
BaseClassName no escopo global).
Python também suporta uma forma de herança múltipla. Uma definição de classe com
várias classes bases tem esta forma:
class DerivedClassName(Base1, Base2, Base3):
<statement-1>
.
.
.
<statement-N>
Para a maioria dos casos mais simples, pense na pesquisa de atributos herdados de uma
classe pai como o primeiro nível de profundidade, da esquerda para a direita, não pes-
quisando duas vezes na mesma classe em que há uma sobreposição na hierarquia. As-
sim, se um atributo não é encontrado em DerivedClassName , é procurado em Base1 ,
depois, recursivamente, nas classes base de Base1 , e se não for encontrado lá, é pes-
quisado em Base2 e assim por diante.
De fato, é um pouco mais complexo que isso; a ordem de resolução de métodos muda
dinamicamente para suportar chamadas cooperativas para super() . Essa abordagem é
conhecida em outras linguagens de herança múltipla como chamar-o-próximo-método, e
é mais poderosa que a chamada à função super, encontrada em linguagens de herança
única.
A desfiguração de nomes é útil para que subclasses possam sobrescrever métodos sem
quebrar invocações de métodos dentro de outra classe. Por exemplo:
class Mapping:
def __init__(self, iterable):
self.items_list = []
self.__update(iterable)
class MappingSubclass(Mapping):
Note que as regras de desfiguração de nomes foram projetadas para evitar acidentes;
ainda é possível acessar ou modificar uma variável que é considerada privada. Isso pode
ser útil em certas circunstâncias especiais, como depuração de código.
Código passado para exec() ou eval() não considera o nome da classe que invocou
como sendo a classe corrente; isso é semelhante ao funcionamento da instrução
global , cujo efeito se aplica somente ao código que é compilado junto. A mesma restri-
ção se aplica às funções getattr() , setattr() e delattr() , e quando acessamos
diretamente o __dict__ da classe.
9.7. Curiosidades e conclusões
Às vezes, é útil ter um tipo semelhante ao “record” de Pascal ou ao “struct” de C, para
agrupar alguns itens de dados. A maneira pythônica para este fim é usar dataclasses :
@dataclass
class Employee:
name: str
dept: str
salary: int
Um trecho de código Python que espera um tipo de dado abstrato em particular, pode
receber, ao invés disso, uma classe que imita os métodos que aquele tipo suporta. Por
exemplo, se você tem uma função que formata dados obtidos de um objeto do tipo “ar-
quivo”, pode definir uma classe com métodos read() e readline() que obtém os da-
dos de um “buffer de caracteres” e passar como argumento.
9.8. Iteradores
Você já deve ter notado que pode usar laços for com a maioria das coleções em
Python:
Esse estilo de acesso é claro, conciso e conveniente. O uso de iteradores permeia e uni-
fica o Python. Nos bastidores, a instrução for chama iter() no objeto contêiner. A
função retorna um objeto iterador que define o método __next__() que acessa ele-
mentos no contêiner, um de cada vez. Quando não há mais elementos, __next__() le-
vanta uma exceção StopIteration que informa ao for para terminar. Você pode cha-
mar o método __next__() usando a função embutida next() ; este exemplo mostra
como tudo funciona:
Observando o mecanismo por trás do protocolo dos iteradores, fica fácil adicionar esse
comportamento às suas classes. Defina um método __iter__() que retorna um objeto
que tenha um método __next__() . Se uma classe já define __next__() , então
__iter__() pode simplesmente retornar self :
class Reverse:
"""Iterator for looping over a sequence backwards."""
def __init__(self, data):
self.data = data
self.index = len(data)
def __iter__(self):
return self
def __next__(self):
if self.index == 0:
raise StopIteration
self.index = self.index - 1
return self.data[self.index]
9.9. Geradores
Geradores são uma ferramenta simples e poderosa para criar iteradores. São escritos
como funções normais mas usam a instrução yield quando precisam retornar dados.
Cada vez que next() é chamado, o gerador volta ao ponto onde parou (lembrando to-
dos os valores de dados e qual instrução foi executada pela última vez). Um exemplo
mostra como geradores podem ser trivialmente fáceis de criar:
def reverse(data):
for index in range(len(data)-1, -1, -1):
yield data[index]
Qualquer coisa que possa ser feita com geradores também pode ser feita com iteradores
baseados numa classe, como descrito na seção anterior. O que torna geradores tão
compactos é que os métodos __iter__() e __next__() são criados automaticamen-
te.
Outro ponto chave é que as variáveis locais e o estado da execução são preservados au-
tomaticamente entre as chamadas. Isto torna a função mais fácil de escrever e muito
mais clara do que uma implementação usando variáveis de instância como self.index
e self.data .
Exemplos:
Notas de rodapé
[1] Exceto por uma coisa. Os objetos módulo têm um atributo secreto e somente para
leitura chamado __dict__ que retorna o dicionário usado para implementar o espa-
ço de nomes do módulo; o nome __dict__ é um atributo, mas não um nome global.
Obviamente, usar isso viola a abstração da implementação do espaço de nomes, e
deve ser restrito a coisas como depuradores post-mortem.