typing: allow union types for instance_of

fixes #1336
python-attrs · Dec 14, 2024 · 1094ba5 · 1094ba5
1 parent 103d51f
commit 1094ba5
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 0 deletions.
diff --git a/changelog.d/1385.change.md b/changelog.d/1385.change.md
@@ -0,0 +1,2 @@
+`attrs.validators.instance_of()`'s type hints now allow for union types.
+For example: `instance_of(str | int)`
diff --git a/src/attr/validators.pyi b/src/attr/validators.pyi
@@ -1,3 +1,4 @@
+from types import UnionType
 from typing import (
     Any,
     AnyStr,
@@ -44,6 +45,8 @@ def instance_of(
 ) -> _ValidatorType[_T1 | _T2 | _T3]: ...
 @overload
 def instance_of(type: tuple[type, ...]) -> _ValidatorType[Any]: ...
+@overload
+def instance_of(type: UnionType) -> _ValidatorType[_T]: ...
 def optional(
     validator: (
         _ValidatorType[_T]

diff --git a/tests/typing_example.py b/tests/typing_example.py
@@ -228,6 +228,9 @@ class Validated:
     k: int | str | C = attr.ib(
         validator=attrs.validators.instance_of((int, C, str))
     )
+    kk: int | str | C = attr.ib(
+        validator=attrs.validators.instance_of(int | C | str)
+    )
 
     l: Any = attr.ib(
         validator=attr.validators.not_(attr.validators.in_("abc"))
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		`attrs.validators.instance_of()`'s type hints now allow for union types.
		For example: `instance_of(str \| int)`