bpo-33018: Improve issubclass() error checking and message. by jab · Pull Request #5944 · python/cpython (original) (raw)
If you try something like issubclass('not a class', str), you get a helpful error message that immediately clues you in on what you did wrong:
issubclass('not a class', str) TypeError: issubclass() arg 1 must be a class
("AHA! I meant isinstance there. Thanks, friendly error message!")
But if you try this with some ABC, the error message is much less friendly!
from some_library import SomeAbc issubclass('not a class', SomeAbc) Traceback (most recent call last): File "", line 1, in File "/usr/local/Cellar/python3/3.6.4_2/Frameworks/Python.framework/Versions/3.6/lib/python3.6/abc.py", line 230, in subclasscheck cls._abc_negative_cache.add(subclass) File "/usr/local/Cellar/python3/3.6.4_2/Frameworks/Python.framework/Versions/3.6/lib/python3.6/_weakrefset.py", line 84, in add self.data.add(ref(item, self._remove)) TypeError: cannot create weak reference to 'str' object
("WTF just went wrong?" Several more minutes of head-scratching ensues. Maybe a less experienced Python programmer who hits this hasn't seen weakrefs before and gets overwhelmed, maybe needlessly proceeding down a deep rabbit hole before realizing no knowledge of weakrefs was required to understand what they did wrong.)
Or how about this example:
from collections import Reversible issubclass([1, 2, 3], Reversible) Traceback (most recent call last): File "", line 1, in File "/usr/local/Cellar/python3/3.6.4_2/Frameworks/Python.framework/Versions/3.6/lib/python3.6/abc.py", line 207, in subclasscheck ok = cls.subclasshook(subclass) File "/usr/local/Cellar/python3/3.6.4_2/Frameworks/Python.framework/Versions/3.6/lib/python3.6/_collections_abc.py", line 305, in subclasshook return _check_methods(C, "reversed", "iter") File "/usr/local/Cellar/python3/3.6.4_2/Frameworks/Python.framework/Versions/3.6/lib/python3.6/_collections_abc.py", line 73, in _check_methods mro = C.mro AttributeError: 'list' object has no attribute 'mro'
Here you don't even get the same type of error (AttributeError rather than TypeError), which seems unintentionally inconsistent.
This trivial patch fixes this, and will hopefully save untold numbers of future Python programmers some time and headache.
Let me know if any further changes are required, and thanks in advance for reviewing.