summaryrefslogtreecommitdiff
path: root/lib/sqlalchemy
diff options
context:
space:
mode:
authorMike Bayer <mike_mp@zzzcomputing.com>2022-09-25 21:40:48 -0400
committerMike Bayer <mike_mp@zzzcomputing.com>2022-09-25 21:41:14 -0400
commit74f6e38ec717979bcde76244c94b1d8c519a5b63 (patch)
treee36e3c8a6fc1c7d04b1d34007ea4a71fef47a453 /lib/sqlalchemy
parente708cfea0bdaae82ac30dd7d33f9442115b9af6d (diff)
downloadsqlalchemy-74f6e38ec717979bcde76244c94b1d8c519a5b63.tar.gz
add typing for sqlalchemy.orm.validates
Fixes: #8577 Change-Id: Iede1c956078960fb866da45f1ac6aa43842516bc
Diffstat (limited to 'lib/sqlalchemy')
-rw-r--r--lib/sqlalchemy/orm/mapper.py14
1 files changed, 8 insertions, 6 deletions
diff --git a/lib/sqlalchemy/orm/mapper.py b/lib/sqlalchemy/orm/mapper.py
index 98c0eba0c..553f7b35b 100644
--- a/lib/sqlalchemy/orm/mapper.py
+++ b/lib/sqlalchemy/orm/mapper.py
@@ -118,6 +118,8 @@ if TYPE_CHECKING:
_T = TypeVar("_T", bound=Any)
_MP = TypeVar("_MP", bound="MapperProperty[Any]")
+_Fn = TypeVar("_Fn", bound="Callable[..., Any]")
+
_WithPolymorphicArg = Union[
Literal["*"],
@@ -3895,7 +3897,9 @@ def reconstructor(fn):
return fn
-def validates(*names, **kw):
+def validates(
+ *names: str, include_removes: bool = False, include_backrefs: bool = False
+) -> Callable[[_Fn], _Fn]:
r"""Decorate a method as a 'validator' for one or more named properties.
Designates a method as a validator, a method which receives the
@@ -3930,12 +3934,10 @@ def validates(*names, **kw):
:ref:`simple_validators` - usage examples for :func:`.validates`
"""
- include_removes = kw.pop("include_removes", False)
- include_backrefs = kw.pop("include_backrefs", True)
- def wrap(fn):
- fn.__sa_validators__ = names
- fn.__sa_validation_opts__ = {
+ def wrap(fn: _Fn) -> _Fn:
+ fn.__sa_validators__ = names # type: ignore[attr-defined]
+ fn.__sa_validation_opts__ = { # type: ignore[attr-defined]
"include_removes": include_removes,
"include_backrefs": include_backrefs,
}