abc
— Abstract Base Classes¶
Código-fonte: Lib/abc.py
Este módulo fornece a infraestrutura para definir classes base abstratas (CBAs. Sigla em inglês ABC, de abstract base class) em Python, como delineado em PEP 3119; veja o PEP para entender o porquê isto foi adicionado ao Python. (Veja também PEP 3141 e o módulo numbers
sobre uma hierarquia de tipo para números baseado nas CBAs.)
The collections
module has some concrete classes that derive from
ABCs; these can, of course, be further derived. In addition, the
collections.abc
submodule has some ABCs that can be used to test whether
a class or instance provides a particular interface, for example, if it is
hashable or if it is a mapping.
Este módulo fornece a metaclasse ABCMeta
para definir CBAs e uma classe auxiliar ABC
para alternativamente definir CBAs através de herança:
- class abc.ABC¶
A helper class that has
ABCMeta
as its metaclass. With this class, an abstract base class can be created by simply deriving fromABC
avoiding sometimes confusing metaclass usage, for example:from abc import ABC class MyABC(ABC): pass
Note that the type of
ABC
is stillABCMeta
, therefore inheriting fromABC
requires the usual precautions regarding metaclass usage, as multiple inheritance may lead to metaclass conflicts. One may also define an abstract base class by passing the metaclass keyword and usingABCMeta
directly, for example:from abc import ABCMeta class MyABC(metaclass=ABCMeta): pass
Adicionado na versão 3.4.
- class abc.ABCMeta¶
Metaclasse para definir Classe Base Abstrata (CBAs).
Use esta metaclasse para criar uma CBA. Uma CBA pode ser diretamente subclasseada, e então agir como uma classe misturada. Você também pode registrar classes concretas não relacionadas (até mesmo classes embutidas) e CBAs não relacionadas como “subclasses virtuais” – estas e suas descendentes serão consideradas subclasses da CBA de registro pela função embutida
issubclass()
, mas a CBA de registro não irá aparecer na ORM (Ordem de Resolução do Método) e nem as implementações do método definidas pela CBA de registro será chamável (nem mesmo viasuper()
). [1]Classes created with a metaclass of
ABCMeta
have the following method:- register(subclass)¶
Registrar subclasse como uma “subclasse virtual” desta CBA. Por exemplo:
from abc import ABC class MyABC(ABC): pass MyABC.register(tuple) assert issubclass(tuple, MyABC) assert isinstance((), MyABC)
Alterado na versão 3.3: Retorna a subclasse registrada, para permitir o uso como um decorador de classe.
Alterado na versão 3.4: To detect calls to
register()
, you can use theget_cache_token()
function.
Você também pode sobrepor este método em uma classe base abstrata:
- __subclasshook__(subclass)¶
(Deve obrigatoriamente ser definido como um método de classe.)
Check whether subclass is considered a subclass of this ABC. This means that you can customize the behavior of
issubclass()
further without the need to callregister()
on every class you want to consider a subclass of the ABC. (This class method is called from the__subclasscheck__()
method of the ABC.)This method should return
True
,False
orNotImplemented
. If it returnsTrue
, the subclass is considered a subclass of this ABC. If it returnsFalse
, the subclass is not considered a subclass of this ABC, even if it would normally be one. If it returnsNotImplemented
, the subclass check is continued with the usual mechanism.
Para uma demonstração destes conceitos, veja este exemplo de definição CBA:
class Foo: def __getitem__(self, index): ... def __len__(self): ... def get_iterator(self): return iter(self) class MyIterable(ABC): @abstractmethod def __iter__(self): while False: yield None def get_iterator(self): return self.__iter__() @classmethod def __subclasshook__(cls, C): if cls is MyIterable: if any("__iter__" in B.__dict__ for B in C.__mro__): return True return NotImplemented MyIterable.register(Foo)
The ABC
MyIterable
defines the standard iterable method,__iter__()
, as an abstract method. The implementation given here can still be called from subclasses. Theget_iterator()
method is also part of theMyIterable
abstract base class, but it does not have to be overridden in non-abstract derived classes.The
__subclasshook__()
class method defined here says that any class that has an__iter__()
method in its__dict__
(or in that of one of its base classes, accessed via the__mro__
list) is considered aMyIterable
too.Finally, the last line makes
Foo
a virtual subclass ofMyIterable
, even though it does not define an__iter__()
method (it uses the old-style iterable protocol, defined in terms of__len__()
and__getitem__()
). Note that this will not makeget_iterator
available as a method ofFoo
, so it is provided separately.
The abc
module also provides the following decorator:
- @abc.abstractmethod¶
Um decorador indicando métodos abstratos.
Using this decorator requires that the class’s metaclass is
ABCMeta
or is derived from it. A class that has a metaclass derived fromABCMeta
cannot be instantiated unless all of its abstract methods and properties are overridden. The abstract methods can be called using any of the normal ‘super’ call mechanisms.abstractmethod()
may be used to declare abstract methods for properties and descriptors.Dynamically adding abstract methods to a class, or attempting to modify the abstraction status of a method or class once it is created, are only supported using the
update_abstractmethods()
function. Theabstractmethod()
only affects subclasses derived using regular inheritance; “virtual subclasses” registered with the ABC’sregister()
method are not affected.When
abstractmethod()
is applied in combination with other method descriptors, it should be applied as the innermost decorator, as shown in the following usage examples:class C(ABC): @abstractmethod def my_abstract_method(self, arg1): ... @classmethod @abstractmethod def my_abstract_classmethod(cls, arg2): ... @staticmethod @abstractmethod def my_abstract_staticmethod(arg3): ... @property @abstractmethod def my_abstract_property(self): ... @my_abstract_property.setter @abstractmethod def my_abstract_property(self, val): ... @abstractmethod def _get_x(self): ... @abstractmethod def _set_x(self, val): ... x = property(_get_x, _set_x)
In order to correctly interoperate with the abstract base class machinery, the descriptor must identify itself as abstract using
__isabstractmethod__
. In general, this attribute should beTrue
if any of the methods used to compose the descriptor are abstract. For example, Python’s built-inproperty
does the equivalent of:class Descriptor: ... @property def __isabstractmethod__(self): return any(getattr(f, '__isabstractmethod__', False) for f in (self._fget, self._fset, self._fdel))
Nota
Diferente de métodos abstratos Java, esses métodos abstratos podem ter uma implementação. Esta implementação pode ser chamada via mecanismo da
super()
da classe que a substitui. Isto pode ser útil como um ponto final para uma super chamada em um framework que usa herança múltipla cooperativa.
The abc
module also supports the following legacy decorators:
- @abc.abstractclassmethod¶
Adicionado na versão 3.2.
Obsoleto desde a versão 3.3: Agora é possível usar
classmethod
comabstractmethod()
, tornando redundante este decorador.Uma subclasse da
classmethod()
embutida, indicando um método de classe abstrato. Caso contrário, é similar àabstractmethod()
.Este caso especial está descontinuado, pois o decorador da
classmethod()
está agora corretamente identificado como abstrato quando aplicado a um método abstrato:class C(ABC): @classmethod @abstractmethod def my_abstract_classmethod(cls, arg): ...
- @abc.abstractstaticmethod¶
Adicionado na versão 3.2.
Obsoleto desde a versão 3.3: Agora é possível usar
staticmethod
comabstractmethod()
, tornando redundante este decorador.Uma subclasse da
staticmethod()
embutida, indicando um método estático abstrato. Caso contrário, ela é similar àabstractmethod()
.Este caso especial está descontinuado, pois o decorador da
staticmethod()
está agora corretamente identificado como abstrato quando aplicado a um método abstrato:class C(ABC): @staticmethod @abstractmethod def my_abstract_staticmethod(arg): ...
- @abc.abstractproperty¶
Obsoleto desde a versão 3.3: Agora é possível usar
property
,property.getter()
,property.setter()
eproperty.deleter()
comabstractmethod()
, tornando redundante este decorador.Uma subclasse da
property()
embutida, indicando uma propriedade abstrata.Este caso especial está descontinuado, pois o decorador da
property()
está agora corretamente identificado como abstrato quando aplicado a um método abstrato:class C(ABC): @property @abstractmethod def my_abstract_property(self): ...
O exemplo acima define uma propriedade somente leitura; você também pode definir uma propriedade abstrata de leitura e escrita marcando apropriadamente um ou mais dos métodos subjacentes como abstratos:
class C(ABC): @property def x(self): ... @x.setter @abstractmethod def x(self, val): ...
Se apenas alguns componentes são abstratos, apenas estes componentes precisam ser atualizados para criar uma propriedade concreta em uma subclasse:
class D(C): @C.x.setter def x(self, val): ...
The abc
module also provides the following functions:
- abc.get_cache_token()¶
Retorna o token de cache da classe base abstrata atual.
O token é um objeto opaco (que suporta teste de igualdade) identificando a versão atual do cache da classe base abstrata para subclasses virtuais. O token muda a cada chamada ao
ABCMeta.register()
em qualquer CBA.Adicionado na versão 3.4.
- abc.update_abstractmethods(cls)¶
Uma função para recalcular o status de abstração de uma classe abstrata. Esta função deve ser chamada se os métodos abstratos de uma classe foram implementados ou alterados após sua criação. Normalmente, essa função deve ser chamada de dentro de um decorador de classe.
Retorna cls, para permitir o uso como decorador de classe.
Se cls não for uma instância de
ABCMeta
, não faz nada.Nota
Esta função presume que as superclasses de cls já estão atualizadas. Ele não atualiza nenhuma subclasse.
Adicionado na versão 3.10.
Notas de rodapé