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.

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

5.1: Deprecate CheckConstraint.check #2331

Merged
merged 6 commits into from
Aug 22, 2024
Merged

5.1: Deprecate CheckConstraint.check #2331

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
d601f6e
5.1: Deprecate CheckConstraint.check
q0w Aug 9, 2024
4c96c38
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Aug 9, 2024
47a658a
Deprecate check
q0w Aug 10, 2024
109b36a
Add condition attr
q0w Aug 10, 2024
50d1db6
Fixup order
q0w Aug 22, 2024
0e2f651
pyright: Ignore reportDeprecated
q0w Aug 22, 2024
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
13 changes: 13 additions & 0 deletions django-stubs/db/models/constraints.pyi
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,11 +44,24 @@ class BaseConstraint:

class CheckConstraint(BaseConstraint):
check: Q | BaseExpression
condition: Q | BaseExpression

@overload
@deprecated("The check keyword argument is deprecated in favor of condition and will be removed in Django 6.0")
q0w marked this conversation as resolved.
Show resolved Hide resolved
def __init__(
self,
*,
name: str,
check: Q | BaseExpression,
violation_error_code: str | None = None,
violation_error_message: _StrOrPromise | None = None,
) -> None: ...
@overload
def __init__(
self,
*,
name: str,
condition: Q | BaseExpression,
violation_error_code: str | None = None,
violation_error_message: _StrOrPromise | None = None,
) -> None: ...
Expand Down
2 changes: 1 addition & 1 deletion tests/assert_type/db/models/test_constraints.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,4 +13,4 @@
name="unique_mess",
)

CheckConstraint(name="less_than_constraint", check=LessThan[Any](F("months"), 1))
CheckConstraint(name="less_than_constraint", check=LessThan[Any](F("months"), 1)) # pyright: ignore[reportDeprecated]
Loading