Skip to content

Fix optional validator to accept tuples of len > 1 #1496

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.

Sign up for GitHub

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

Open
finite-state-machine wants to merge 10 commits into
base: main
Choose a base branch
from
+15 −1
Open

Fix optional validator to accept tuples of len > 1 #1496

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
e646bd9
Fix `optional` validator to accept tuples of len > 1
finite-state-machine Jan 3, 2026
52cd1d7
Add changelog
finite-state-machine Jan 4, 2026
110c6d2
Add `optional` validator over 2-tuple test case to `baseline.py`
finite-state-machine Jan 4, 2026
61a1dd0
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Jan 4, 2026
c1129cc
Work around `ty` false positive `invalid-argument-type`
finite-state-machine Jan 4, 2026
5b41382
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Jan 4, 2026
849dbee
Revert "fixes" from pre-commit.com hooks [skip pre-commit.ci]
finite-state-machine Jan 4, 2026
3e55d90
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Jan 4, 2026
d19ead3
Merge branch 'main' into FixOptionalValidatorAnnotation
hynek Jan 5, 2026
5a76d59
Merge branch 'main' into FixOptionalValidatorAnnotation
hynek Feb 4, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions changelog.d/1496.change.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Fix type annotations for `optional` validator so it no longer rejects tuples of len > 1
2 changes: 1 addition & 1 deletion src/attr/validators.pyi
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ def optional(
validator: (
_ValidatorType[_T]
| list[_ValidatorType[_T]]
| tuple[_ValidatorType[_T]]
| tuple[_ValidatorType[_T], ...]
),
) -> _ValidatorType[_T | None]: ...
def in_(options: Container[_T]) -> _ValidatorType[_T]: ...
Expand Down
13 changes: 13 additions & 0 deletions typing-examples/baseline.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -94,6 +94,19 @@ class Validated:
num: int = attrs.field(validator=attrs.validators.ge(0))


@attrs.define
class ValidatedOptionalOverTuple:
num: int | None = attrs.field(
validator=attrs.validators.optional(
(attrs.validators.instance_of(int), attrs.validators.ge(0))
# `int(0)` needed to avoid false positive
# `invalid-argument-type` when checking with
# ty 0.0.8 (aa7559db8 2025-12-29): ty assumes `ge`'s
# specialization is `Literal[0]` rather than `int`
)
)


@attrs.define
class ValidatedInconsistentOr:
num: int | str = attrs.field(
Expand Down
Loading