Because I am used to the old ways of duck typing in Python, I fail to understand the need for ABC (abstract base classes). Thehelp is good on how to use them.
I tried to read the rationale in thePEP, but it went over my head. If I was looking for a mutable sequence container, I would check for__setitem__
, or more likely try to use it (EAFP). I haven't come across a real life use for thenumbers module, which does use ABCs, but that is the closest I have to understanding.
Can anyone explain the rationale to me, please?
6 Answers6
@Oddthinking's answer is not wrong, but I think it misses thereal,practical reason Python has ABCs in a world of duck-typing.
Abstract methods are neat, but in my opinion they don't really fill any use-cases not already covered by duck typing. Abstract base classes' real power lies inthe way they allow you to customise the behaviour ofisinstance
andissubclass
. (__subclasshook__
is basically a friendlier API on top of Python's__instancecheck__
and__subclasscheck__
hooks.) Adapting built-in constructs to work on custom types is very much part of Python's philosophy.
Python's source code is exemplary.Here is howcollections.Container
is defined in the standard library (at time of writing):
class Container(metaclass=ABCMeta): __slots__ = () @abstractmethod def __contains__(self, x): return False @classmethod def __subclasshook__(cls, C): if cls is Container: if any("__contains__" in B.__dict__ for B in C.__mro__): return True return NotImplemented
This definition of__subclasshook__
says that any class with a__contains__
attribute is considered to be a subclass of Container, even if it doesn't subclass it directly. So I can write this:
class ContainAllTheThings(object): def __contains__(self, item): return True>>> issubclass(ContainAllTheThings, collections.Container)True>>> isinstance(ContainAllTheThings(), collections.Container)True
In other words,if you implement the right interface, you're a subclass! ABCs provide a formal way to define interfaces in Python, while staying true to the spirit of duck-typing. Besides, this works in a way that honours theOpen-Closed Principle.
Python's object model looks superficially similar to that of a more "traditional" OO system (by which I mean Java*) - we got yer classes, yer objects, yer methods - but when you scratch the surface you'll find something far richer and more flexible. Likewise, Python's notion of abstract base classes may be recognisable to a Java developer, but in practice they are intended for a very different purpose.
I sometimes find myself writing polymorphic functions that can act on a single item or a collection of items, and I findisinstance(x, collections.Iterable)
to be much more readable thanhasattr(x, '__iter__')
or an equivalenttry...except
block. (If you didn't know Python, which of those three would make the intention of the code clearest?)
That said, I find that I rarely need to write my own ABC and I typically discover the need for one through refactoring. If I see a polymorphic function making a lot of attribute checks, or lots of functions making the same attribute checks, that smell suggests the existence of an ABC waiting to be extracted.
*without getting into the debate over whether Java is a "traditional" OO system...
Addendum: Even though an abstract base class can override the behaviour ofisinstance
andissubclass
, it still doesn't enter theMRO of the virtual subclass. This is a potential pitfall for clients: not every object for whichisinstance(x, MyABC) == True
has the methods defined onMyABC
.
class MyABC(metaclass=abc.ABCMeta): def abc_method(self): pass @classmethod def __subclasshook__(cls, C): return Trueclass C(object): pass# typical client codec = C()if isinstance(c, MyABC): # will be true c.abc_method() # raises AttributeError
Unfortunately this one of those "just don't do that" traps (of which Python has relatively few!): avoid defining ABCs with both a__subclasshook__
and non-abstract methods. Moreover, you should make your definition of__subclasshook__
consistent with the set of abstract methods your ABC defines.
7 Comments
isinstance(x, collections.Iterable)
is clearer for me, and I do know Python.C
subclass delete (or screw up beyond repair) theabc_method()
inherited fromMyABC
. The principal difference is that it's the superclass that is screwing up the inheritance contract, not the subclass.Container.register(ContainAllTheThings)
for the given example to work?__subclasshook__
is "any class which satisfies this predicate is considered a subclass for the purposes ofisinstance
andissubclass
checks,regardless of whether it was registered with the ABC, andregardless of whether it's a direct subclass". As I said in the answer,if you implement the right interface, you're a subclass!Short version
ABCs offer a higher level of semantic contract between clients and the implemented classes.
Long version
There is a contract between a class and its callers. The class promises to do certain things and have certain properties.
There are different levels to the contract.
At a very low level, the contract might include the name of a method or its number of parameters.
In a staticly-typed language, that contract would actually be enforced by the compiler. In Python, you can useEAFP or type introspection to confirm that the unknown object meets this expected contract.
But there are also higher-level, semantic promises in the contract.
For example, if there is a__str__()
method, it is expected to return a string representation of the object. Itcould delete all contents of the object, commit the transaction and spit a blank page out of the printer... but there is a common understanding of what it should do, described in the Python manual.
That's a special case, where the semantic contract is described in the manual. What should theprint()
method do? Should it write the object to a printer or a line to the screen, or something else? It depends - you need to read the comments to understand the full contract here. A piece of client code that simply checks that theprint()
method exists has confirmed part of the contract - that a method call can be made, but not that there is agreement on the higher level semantics of the call.
Defining an Abstract Base Class (ABC) is a way of producing a contract between the class implementers and the callers. It isn't just a list of method names, but a shared understanding of what those methods should do. If you inherit from this ABC, you are promising to follow all the rules described in the comments, including the semantics of theprint()
method.
Python's duck-typing has many advantages in flexibility over static-typing, but it doesn't solve all the problems. ABCs offer an intermediate solution between the free-form of Python and the bondage-and-discipline of a staticly-typed language.
10 Comments
__contains__
and a class that inherits fromcollections.Container
? In your example, in Python there was always a shared understanding of__str__
. Implementing__str__
makes the same promises as inheriting from some ABC and then implementing__str__
. In both cases you can break the contract; there are no provable semantics such as the ones we have in static typing.collections.Container
is a degenerate case, that only includes\_\_contains\_\_
, and only to mean the predefined convention. Using an ABC doesn't add much value by itself, I agree. I suspect it was added to allow (for e.g.)Set
to inherit from it. By the time you get toSet
, suddenly belonging to the the ABC has considerable semantics. An item can't belong to the collection twice. That is NOT detectable by the existence of methods.Set
is a better example thanprint()
. I was attempting to find a method name whose meaning was ambiguous, and couldn't be grokked by the name alone, so you couldn't be sure that it would do the right thing just by its name and the Python manual.Set
as the example instead ofprint
?Set
makes a lot of sense, @Oddthinking.A handy feature of ABCs is that if you don't implement all necessary methods (and properties) you get an error upon instantiation, rather than anAttributeError
, potentially much later, when you actually try to use the missing method.
from abc import ABCMeta, abstractmethod# python2class Base(object): __metaclass__ = ABCMeta @abstractmethod def foo(self): pass @abstractmethod def bar(self): pass# python3class Base(object, metaclass=ABCMeta): @abstractmethod def foo(self): pass @abstractmethod def bar(self): passclass Concrete(Base): def foo(self): pass # We forget to declare `bar`c = Concrete()# TypeError: "Can't instantiate abstract class Concrete with abstract methods bar"
Example fromhttps://dbader.org/blog/abstract-base-classes-in-python
Edit: to include python3 syntax, thanks @PandasRocks
3 Comments
It will make determining whether an object supports a given protocol without having to check for presence of all the methods in the protocol or without triggering an exception deep in "enemy" territory due to non-support much easier.
Comments
Abstract methods make sure that whatever method you are calling in the parent class, has to also appear in the child class. Below are normal ways of calling and using abstract.The program is written in python3
Normal way of calling:
class Parent: def method_one(self): raise NotImplemented() def method_two(self): raise NotImplementedError()class Son(Parent): def method_one(self): return 'method_one() is called'c = Son()c.method_one()
'method_one() is called'
c.method_two()
NotImplementedError
With Abstract method:
from abc import ABCMeta, abstractmethodclass Parent(metaclass=ABCMeta): @abstractmethod def method_one(self): raise NotImplementedError() @abstractmethod def method_two(self): raise NotImplementedError()class Son(Parent): def method_one(self): return 'method_one() is called'c = Son()
TypeError: Can't instantiate abstract class Son with abstract methods method_two.
Since method_two is not called in child class we got error. The proper implementation is below:
from abc import ABCMeta, abstractmethodclass Parent(metaclass=ABCMeta): @abstractmethod def method_one(self): raise NotImplementedError() @abstractmethod def method_two(self): raise NotImplementedError()class Son(Parent): def method_one(self): return 'method_one() is called' def method_two(self): return 'method_two() is called'c = Son()c.method_one()
'method_one() is called'
3 Comments
abstractmethod
.@abstractmethod
decorator must be implemented in the child class. If we leave a single one, we will get theCan't instantiate abstract class
error. If this is true, than this is very useful thing.ABC's enable design patterns and frameworks to be created. Please see this pycon talk by Brandon Rhodes:
The protocols within Python itself (not to mention iterators, decorators, and slots (which themselves implement the FlyWeight pattern)) are all possible because of ABC's (albeit implemented as virtual methods/classes in CPython).
Duck typing does make some patterns trivial in python, which Brandon mentions, but many other patterns continue to pop up and be useful in Python, e.g. Adapters.
In short, ABC's enable you to write scalable and reusable code. Per the GoF:
Program to an interface, not an implementation (inheritance breaks encapsulation; programming to an interface promotes loose-coupling/inversion of control/the "HollyWood Principle: Don't call us, we'll call you")
Favor object composition over class inheritance (delegate the work)
Encapsulate the concept that varies (the open-closed principle makes classes open for extension, but closed for modification)
Additionally, with the emergence of static type checkers for Python (e.g.mypy
), an ABC can be used as a type instead ofUnion[...]
for every object a function accepts as an argument or returns. Imagine having to update the types, not the implementation, every time your code base supports a new object? That gets unmaintainable (doesn't scale) very fast.
2 Comments
Explore related questions
See similar questions with these tags.