How should I type my validators? #524

jml · 2019-04-03T03:40:47Z

I'm trying to add some types to some attrs-using code that uses validators.

Here's a minimal example of such:

from typing import Any, TypeVar

from attr import Attribute

T = TypeVar("T")


def my_validator(instance: Any, attribute: Attribute[T], value: T) -> Any:
    pass

The type is derived by looking at attr/validators.pyi and attr/__init__.pyi.

The code type-checks fine, but fails to execute:

jml@hope:~
$ mypy --strict attribute.py
jml@hope:~
$ python attribute.py
Traceback (most recent call last):
  File "attribute.py", line 8, in <module>
    def my_validator(instance: Any, attribute: Attribute[T], value: T) -> Any:
TypeError: 'type' object is not subscriptable

If I remove the [T], the opposite happens:

jml@hope:~
$ mypy --strict attribute.py
attribute.py:8: error: Missing type parameters for generic type
jml@hope:~
$ python attribute.py

What type should my validators have?

oremanj · 2019-04-03T06:45:42Z

Looks like Attribute is generic in the stubs but not in the runtime code. This isn't an issue that's unique to attrs, and there's an entry about it in the mypy manual: https://mypy.readthedocs.io/en/latest/common_issues.html#using-classes-that-are-generic-in-stubs-but-not-at-runtime

In this case the easiest fix is probably to escape the type hint by writing it in quotes: attribute: "Attribute[T]". Or if you're on 3.7+, consider from __future__ import annotations.

wsanchez added Documentation Typing labels May 3, 2019

Oct	NOV	Dec
	27
2019	2020	2021

python-attrs / attrs

How should I type my validators? #524

How should I type my validators? #524

jml commented Apr 3, 2019

oremanj commented Apr 3, 2019

python-attrs / attrs

Sponsor python-attrs/attrs

Join GitHub today

GitHub is where the world builds software

How should I type my validators? #524

How should I type my validators? #524

Comments

jml commented Apr 3, 2019

oremanj commented Apr 3, 2019

Essential cookies

Always active

Analytics cookies