Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

bpo-44975: [typing] Support issubclass for ClassVar data members #27883

Closed
Next Next commit
Support issubclass for ClassVar data members
  • Loading branch information
Fidget-Spinner committed Aug 22, 2021
commit a613af69372d0b4682a7e95360ead6044c649d50
5 changes: 5 additions & 0 deletions Doc/library/typing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1247,6 +1247,11 @@ These are not used in annotations. They are building blocks for creating generic

.. versionadded:: 3.8

.. versionchanged:: 3.11
Protocols with data members annotated with :data:`ClassVar` now support
:func:`issubclass` checks. Subclasses must set these data members to pass.


Other special directives
""""""""""""""""""""""""

Expand Down
8 changes: 8 additions & 0 deletions Doc/whatsnew/3.11.rst
Original file line number Diff line number Diff line change
Expand Up @@ -219,6 +219,14 @@ sqlite3
(Contributed by Erlend E. Aasland in :issue:`44688`.)


typing
------

* Runtime protocols with data members now support :func:`issubclass` as long
as those members are annotated with :data:`typing.ClassVar`.
(Contributed by Ken Jin in :issue:`44975`).


Removed
=======
* :class:`smtpd.MailmanProxy` is now removed as it is unusable without
Expand Down
12 changes: 12 additions & 0 deletions Lib/test/test_typing.py
Original file line number Diff line number Diff line change
Expand Up @@ -1610,6 +1610,18 @@ class P(Protocol):
with self.assertRaisesRegex(TypeError, "@runtime_checkable"):
isinstance(1, P)

def test_runtime_issubclass_with_classvar_data_members(self):
@runtime_checkable
class P(Protocol):
x: ClassVar[int] = 1

class C: pass

class D:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's also add a case with the same class prop, but different value. Example:

class E:
    x = 2

Because right now all names / values always match. It is not clear whether value is a part of the protocol or not.

Copy link
Member Author

@Fidget-Spinner Fidget-Spinner Dec 5, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Agreed.

It is not clear whether value is a part of the protocol or not.

It shouldn't be. IMO, we should only care about the "shape". Trying to runtime-check the value is difficult and should be left to third-party libs to do.

Nevermind, I changed my mind. Let's do it!

x = 1
self.assertNotIsSubclass(C, P)
self.assertIsSubclass(D, P)
Fidget-Spinner marked this conversation as resolved.
Show resolved Hide resolved

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's also test these classes:

class G:
   x: ClassVar[int] = 1
class H:
   x: 'ClassVar[int]' = 1

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These aren't testing more code paths, the code doesn't look at the annotations of the first class argument in issubclass.


class GenericTests(BaseTestCase):

Expand Down
14 changes: 11 additions & 3 deletions Lib/typing.py
Original file line number Diff line number Diff line change
Expand Up @@ -1396,8 +1396,15 @@ def _get_protocol_attrs(cls):


def _is_callable_members_only(cls):
attr_names = _get_protocol_attrs(cls)
annotations = getattr(cls, '__annotations__', {})
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What about using typing.get_type_hints to resolve annotations for a class?

It will allow having ClassVar annotated as str:

@runtime_checkable
class P(Protocol):
    x: 'ClassVar[int]' = 1
Suggested change
annotations = getattr(cls, '__annotations__', {})
annotations = get_type_hints(cls)

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good question! I'd considered that too but decided against it for two main reasons:

  1. get_type_hints is slow
  2. get_type_hints won't work with forward references/ PEP 563 if ClassVar is not defined in the caller's namespace

Consider the following:

# foo.py
from __future__ import annotations
from typing import *

@runtime_checkable
class X(Protocol):
 x: ClassVar[int] = 1
 y: SomeUndeclaredType = None
# bar.py
from .foo import X
class Y: ...

# Error! get_type_hints cannot resolve 'ClassVar' and 'SomeUndeclaredType'
issubclass(X, Y)

Nonetheless, your suggestion has reminded me of a basic workaround for string annotations. Thanks.

# PEP 544 prohibits using issubclass() with protocols that have non-method members.
return all(callable(getattr(cls, attr, None)) for attr in _get_protocol_attrs(cls))
for attr_name in attr_names:
attr = getattr(cls, attr_name, None)
if not (callable(attr)
or (getattr(annotations.get(attr_name), '__name__', None) == 'ClassVar')):
Fidget-Spinner marked this conversation as resolved.
Show resolved Hide resolved
return False
return True


def _no_init(self, *args, **kwargs):
Expand Down Expand Up @@ -1511,8 +1518,9 @@ def _proto_hook(other):
if not _is_callable_members_only(cls):
if _allow_reckless_class_checks():
return NotImplemented
raise TypeError("Protocols with non-method members"
" don't support issubclass()")
raise TypeError("Protocol members must be methods or data"
" attributes annotated with ClassVar to support"
" issubclass()")
if not isinstance(other, type):
# Same error message as for issubclass(1, int).
raise TypeError('issubclass() arg 1 must be a class')
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
Runtime protocols with data members now support :func:`issubclass` as long
as those members are annotated with :data:`typing.ClassVar`.