Kill subclasscheck by ilevkivskyi · Pull Request #283 · python/typing · GitHub

This PR:

Fixes Kill __subclasscheck__ #136
Fixes Bare Union, Callable and Tuple should not be classes #133
Partially fixes typing.MutableMapping not a drop-in replacement for collections.abc.MutableMapping #203 (fixes the isinstance part, and multiple inheritance, still typing.Something is not a drop-in replacement for collections.abc.Something in terms of implementation).
Also fixes http://bugs.python.org/issue26075, http://bugs.python.org/issue25830, and http://bugs.python.org/issue26477
Makes almost everything up to 10x faster.
Is aimed to be a minimalistic change. I only removed issubclass tests from test_typing and main changes to typing are __new__ and __getitem__.

The idea is to make most things not classes. Now _ForwardRef(), TypeVar(), Union[], Tuple[], Callable[] are not classes (i.e. new class objects are almost never created by typing).

Using isinstance() or issubclass() rises TypeError for almost everything. There are exceptions:

Unsubscripted generics are still OK, e.g. issubclass({}, typing.Mapping). This is done to (a) not break existing code by addition of type information; (b) to allow using typing classes as a replacement for collections.abc in class and instance checks. Finally, there is an agreement that a generic without parameters assumes Any, and Any means fallback to dynamic typing.
isinstance(lambda x: x, typing.Callable) is also OK. Although Callable is not a generic class, when unsubscribed, it could be also used as a replacement for collections.abc.Callable.
The first rule for generics makes isinstance([], typing.List) possible, for consistency I also allowed isinstance((), typing.Tuple).

Finally, generics should be classes, to allow subclassing, but now the outcome of __getitem__ on classes is cached. I use an extended version of functools.lru_cache that allows fallback to non-cached version for unhashable arguments.

This is still WIP, since I did this only for Python 3.

@gvanrossum @JukkaL Please take a look.

This reverts commit fa4a681.

@gvanrossum @JukkaL
It looks like this PR also fixes http://bugs.python.org/issue26075, http://bugs.python.org/issue25830, and http://bugs.python.org/issue26477

I added this to the description.

I did a quick pass on the diff and tried it with mypy, and I like it. The changes seem to speed up a no-op mypy invocation (mypy) by roughly 20%, which is nice (though I didn't do very careful benchmarking). There still seems to be maybe a 5-10% slowdown in startup time due to type annotations, but this seems acceptable already.

The generic type object cache hit rate when running mypy -x was about 78% -- increasing the cache size to 50 improved that to 80%. A further increase only had a marginal effect. The improvement with a larger cache might be higher to larger codebases, but it's hard to tell.

This is great! Here are some nits. My main concern is over __slots__ but even that's minor. I haven't reviewed everything (in fact I only reviewed src/typing.py) but I think we should just go ahead and release this with 3.6b2 and hope for the best. Maybe we'll get some real-world feedback from that and we can tweak things before 3.5.3 is finalized (sorry, there's no date in PEP 478, but we'll get ample warning, and I expect it to be around the same time as 3.6.0 goes out, mid December according to PEP 494).

I would rather see import functools, like the following imports. (abstractmethod and -property are special because they are used a lot, and also well-known).

I think this class name should start with _, and ditto for Final below (and probably also TypingMeta above).

Can you capitalize sentences and add a period at the end?

OK, but I still think it should call super().

Questionable, since this is not an end user API. If this error ever were to trigger that would mean the author of typing.py itself had made a mistake. That's why it was just an assert.

Again, I'd still like the super() method called.

Maybe rename to _FinalTypingBase?

We should have a __slots__ here too, otherwise the __slots__ in the subclass is pointless. Also all the final classes (and probably also those inheriting from TypingBase) should have their own __slots__.

(I guess it's a little-known fact that __slots__ only suppresses the __dict__ when used for every class in the MRO...)

Isn't this cache size way too small? I'd expect that a program that benefits from this cache would be pretty large so it would have way more than 50 different generic type instantiations (if I understand that that's what it's caching -- it looks like it's only used on __getitem__ in GenericMeta).

Though when the cache works it's amazing -- I measured 20x speedup on List[int]!

Also, I printed the cache info for running mypy itself, and there 50 seems fine -- with maxsize=50 there are 120 misses, while with maxsize=1000 there are 115 misses, and currsize is also 115, so it seems mypy itself contains 115 distinct generic type instantiations. (The hit count when running on itself was 1071, so that would point to roughly 10x speedup.)

The default maxsize for lru_cache() is 128 -- perhaps just leave it up to that?

…o Python 2

@gvanrossum
Thank you for review! I agree with all comments and implemented them (also in /python2). Except for one: I added _ to _TypingBase and _FinalTypingBase as you requested, but not to TypingMeta, there are few reasons for this:

It was around for a long time (probably since beginning).
Adding underscore there would probably also require adding a lot of them to TupleMeta etc. in /python2.
I think we could keep TypingMeta as a part of "semi-public" API (just in case someone wants to make extensions to typing module or mypy).

@JukkaL
I agree that the cache size should be increased. The idea is that projects that will use typing and mypy are probably very large (this is also Guido's opinion). Now the cache size is 128.

I am going to merge this as-is. While there are a few things left to do, it's easier to do them in a follow-up PR -- this one is just too big to review already.

Only one blank line is required.

Couldn't this use super()?

I'd update the docstring to hint that it prevents instantiation unless _root=True is given.

Maybe add repr(type_var) as the message?

Maybe getting a better error isn't enough reason to insert an extra function call? Or does the cache make this moot?

Over at mypy we've convinced ourselves (with some difficulty!) that this is wrong. Union[int, Any] should not be simplified to Any. Intuitively, the reason is that if x has type Union[int, Any] then calling x.lower() would be a mistake because it's wrong to call .lower() on an int (even though it's okay to call it on an Any). More about this at python/mypy#1642.

Note that this statement is not in question -- in fact this is the reason that we were initially misguided about Union[int, Any]. Technically it just falls under the subclass rule stated above. (You could edit the docstring to make this the corollary.)

I guess getting rid of this check should be sufficient to avoid simplifying away Any. (Also the comment above should be updated.)

This comment is mysterious. I suppose you mean that we only catch TypeErrors so that other errors won't be masked by this. And I recall from a previous version that the issue here is that maybe an argument may not be hashable, and then we want the real error from the uncached function (I think). But TypeError would also be raised for various bugs in func (in general TypeError usually means there's a bug). In the end I think it's fine to just catch TypeError, because the uncached function should reproduce the error exactly. It would also be fine to catch Exception, but presumably unnecessary. So I'm just asking for a better comment. :-)

While type(None) is technically correct I'm not sure how much it adds to mention it here (especially since Union[x, None] and Union[x, type(None)] are always equivalent :-).

Feel free to iterate more on this! Especially the Union[Any, int] issue. But I figured we might as well take a checkpoint, so this is now merged (also into CPython 3.5, 3.6 and 3.7==default). I closed the three CPython bugs you mentioned.

@gvanrossum
Thank you for merging this!
I will submit a new PR for Union[int, Any] in typing.py and probably also PR for PEPs 484 and 483.

This is a good catch, I didn't notice this while editing PEP 483. The point is that type is characterized by two sets: set of values and set of functions (methods), as mentioned in PEP 483. With such definition neither int is not a subtype of Any (since int has less methods) nor vice versa (since Any has more values). The fact that Any is at the same time at the top of type hierarchy (it has all values) and at its bottom (it has all methods) requires us to introduce two different concepts: subtype and compatibility.

Actually, now I think that Any should be considered a subtype of object. Indeed, both have all values, but Any has more methods, therefore it is a subtype of object. This, in turn, means that Union[object, Any] should be simplified to just object. For example, if x has type Union[object, Any] then the only way to call x.lower() is when x is not object, but this is not possible:

x: Union[object, Any]
x.lower()  # this should be rejected
if not isinstance(x, object):
    x.lower()  # this should be allowed, but it is not reachable

What do you think?

(If it will help, the relation between object and Any is similar to relation between, e.g., Mapping and MutableMapping, they both have the same set of values, but MutableMapping has more methods, therefore it is a subtype of Mapping.)

Good reasoning! I like talking about "has more methods" and "has more values".

…, Any] (#288)

ilevkivskyi added 14 commits September 18, 2016 14:51

Started python#136

7d73596

Started python#136

20de824

More work on python#136

8e6f0a6

Finish first round of python#136

bcde4c6

Shorter error messages

9987bb2

Added lru_cache for Generic[]

90d72da

Flexible cache for Generic[]

603ff6d

Skip GenericMeta in FrozenSetMeta MRO

fa4a681

Revert "Skip GenericMeta in FrozenSetMeta MRO"

cc99972

This reverts commit fa4a681.

Remove redundant metaclass for frozenset

b587dc0

Some formatting

e25b303

Fix async/await tests

3ccb7a9

Fixed ContextManger test

0606059

Be consistent about _TypeAlias

8b909d6

ilevkivskyi added 2 commits September 19, 2016 01:21

Removed debugging print()

554f2ed

Simplified code

11189b0

ilevkivskyi added 5 commits September 23, 2016 00:14

Increased cache size to 50; start backporting changes to Python 2

4c91c3b

Backport Union and Optional to Python 2

1920009

Finished backport to Python 2; some polishing is needed

f003eca

Added many unit tests for bugs fixed by PR

e130c77

Updated docstrings and other minor things

fe2d3b7

gvanrossum requested changes Sep 25, 2016

View reviewed changes

ilevkivskyi and others added 5 commits September 26, 2016 01:47

Optimized caching + first part of response to comments

e4cebff

Second part of response to comments. Need to port all comments etc. t…

9b443cb

…o Python 2

Start backporting comments to Python2; improve caching

bd160a1

Get rid of frozensetmeta, it causes random failures

80ce513

Backported everything to Python 2

c4f11e8

ilevkivskyi changed the title [WIP] Kill __subclasscheck__ Kill __subclasscheck__ Sep 26, 2016

ilevkivskyi added 2 commits September 26, 2016 23:47

Do not duplicate real errors while caching

230a500

Merge remote-tracking branch 'origin/master'

e8c85b2

gvanrossum reviewed Sep 27, 2016

View reviewed changes

gvanrossum merged commit 7baf6fe into python:master Sep 27, 2016

gvanrossum mentioned this pull request Sep 27, 2016

typing.MutableMapping not a drop-in replacement for collections.abc.MutableMapping #203

Closed

gvanrossum mentioned this pull request Sep 28, 2016

Fix generics inheritance and drop __subclasscheck__ #207

Closed

gvanrossum pushed a commit that referenced this pull request Sep 29, 2016

Follow up for #283 (response to comments) including change in Union[X…

185df0a

…, Any] (#288)

gvanrossum mentioned this pull request Oct 4, 2016

Python 2 typing.py needs to cache generics too #290

Closed

mkurnikov mentioned this pull request Oct 19, 2016

Check for Match instance in Union[Match, str] python/mypy#2282

Closed

ento mentioned this pull request Oct 24, 2016

Can't copy.copy or deepcopy any type that inherits from _FinalTypingBase #306

Closed

lucaswiman mentioned this pull request Jun 25, 2017

is_member_of_type ilevkivskyi/typing_inspect#2

Closed

AiOO mentioned this pull request May 3, 2019

Compatibility issue with Python 3.7 nirum-lang/nirum-python#117

Open

sveinugu mentioned this pull request Jan 31, 2023

Support Python 3.10 Stewori/pytypes#116

Open

@@ @@ -1,5 +1,6 @@ @@
               import abc
               from abc import abstractmethod, abstractproperty
+              from functools import lru_cache, wraps

                       assert not isinstance(impl_type, TypingMeta), repr(impl_type)
                       self.name = name
-                      self.type_var = type_var
+                      self.type_var = _type_check(type_var, "Type alias accepts only types")

+                              isinstance(args[1], tuple)):
+                          # Close enough.
+                          raise TypeError("Cannot subclass %r" % cls)
+                      return object.__new__(cls)

-                      assert isinstance(type_var, type), repr(type_var)
                       assert isinstance(impl_type, type), repr(impl_type)
                       assert not isinstance(impl_type, TypingMeta), repr(impl_type)
+                      assert isinstance(type_var, (type, _TypingBase))

+                      try:
+                          return cached(*args, **kwds)
+                      except TypeError:
+                          pass  # Do not duplicate real errors.



		class Final:
		class TypingBase(metaclass=TypingMeta, _root=True):

+              class TypingBase(metaclass=TypingMeta, _root=True):
+                  """Indicator of special typing constructs."""
+                  # things that are not classes also need these

                   """Wrapper to hold a forward reference."""
-                  def __new__(cls, arg):
+                  def __init__(self, arg):

                   """
-                  def __new__(cls, name, *constraints, bound=None,
+                  def __init__(self, name, *constraints, bound=None,

		return '{}.{}'.format(cls.__module__, cls.__name__[1:])


		class Final(TypingBase, _root=True):

-              class Final:
+              class _FinalTypingBase(_TypingBase, _root=True):
                   """Mix-in class to prevent instantiation."""

+                  def __new__(cls, *args, **kwds):
+                      """Constructor.
+                      This only exists to give a better error message in case

+                      Union[Manager, int, Employee] == Union[int, Employee]
+                      Union[Employee, Manager] == Employee
+                  - Corollary: if Any is present it is the sole survivor, e.g.::

		@@ -499,22 +597,16 @@ def __new__(cls, name, bases, namespace, parameters=None, _root=False):
		for t1 in params:
		if t1 is Any:

+                  """Optional type.
-                  - You can use Optional[X] as a shorthand for Union[X, None].
+                  Optional[X] is equivalent to Union[X, type(None)].



		def tp_cache(func):
		cached = lru_cache(maxsize=50)(func)

Kill __subclasscheck__ by ilevkivskyi · Pull Request #283 · python/typing · GitHub

Repository navigation

Kill __subclasscheck__ - #283

Kill __subclasscheck__#283gvanrossum merged 28 commits intopython:masterpython/typing:masterfrom ilevkivskyi:masterilevkivskyi/typehinting:masterCopy head branch name to clipboard

Conversation

ilevkivskyi commented Sep 18, 2016 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ilevkivskyi commented Sep 18, 2016

Uh oh!

JukkaL commented Sep 20, 2016

Uh oh!

gvanrossum left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

gvanrossum Sep 25, 2016 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

gvanrossum Sep 25, 2016 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

gvanrossum Sep 25, 2016 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ilevkivskyi commented Sep 26, 2016

Uh oh!

ilevkivskyi commented Sep 26, 2016

Uh oh!

gvanrossum left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

gvanrossum Sep 26, 2016 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

gvanrossum Sep 27, 2016 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

gvanrossum Sep 27, 2016 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

gvanrossum commented Sep 27, 2016

Uh oh!

ilevkivskyi commented Sep 28, 2016

Uh oh!

gvanrossum commented Sep 28, 2016 via email

Uh oh!

Reviewers

Uh oh!

Kill subclasscheck by ilevkivskyi · Pull Request #283 · python/typing · GitHub

Kill subclasscheck - #283

Kill subclasscheck#283
gvanrossum merged 28 commits into
python:masterfrom
ilevkivskyi:master

ilevkivskyi commented Sep 18, 2016 •
edited
Loading

gvanrossum Sep 25, 2016 •
edited
Loading

gvanrossum Sep 25, 2016 •
edited
Loading

gvanrossum Sep 25, 2016 •
edited
Loading

gvanrossum Sep 26, 2016 •
edited
Loading

gvanrossum Sep 27, 2016 •
edited
Loading

gvanrossum Sep 27, 2016 •
edited
Loading