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

Jump to bottom

Deprecate Conditions and Triggers Saved in handler Callable; Save Condition in signal.extra Instead #2608

Merged
merged 8 commits into from Dec 15, 2022
Merged

Deprecate Conditions and Triggers Saved in handler Callable; Save Condition in signal.extra Instead #2608

Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
9af14b9
Save conditions and triggers in dicts
ChihweiLHBird Nov 27, 2022
17401ab
Apply solution written by @ahopkins
ChihweiLHBird Nov 29, 2022
8069adc
Merge branch 'main' into zhiwei/method-signal-handler
ChihweiLHBird Nov 29, 2022
7d3e6df
Add deprecation comment
ChihweiLHBird Dec 7, 2022
0741989
Merge branch 'main' into zhiwei/method-signal-handler
ChihweiLHBird Dec 7, 2022
95191a0
Merge branch 'main' into zhiwei/method-signal-handler
ChihweiLHBird Dec 13, 2022
2d44eef
Fix lint issue
ChihweiLHBird Dec 15, 2022
e2c3d0e
Merge branch 'main' into zhiwei/method-signal-handler
ChihweiLHBird Dec 15, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
14 changes: 9 additions & 5 deletions sanic/signals.py
View file
Open in desktop
Expand Up @@ -154,9 +154,7 @@ async def _dispatch(
try:
for signal in signals:
params.pop("__trigger__", None)
requirements = getattr(
signal.handler, "__requirements__", None
)
requirements = signal.extra.requirements
if (
(condition is None and signal.ctx.exclusive is False)
or (condition is None and not requirements)
Expand Down Expand Up @@ -219,8 +217,13 @@ def add( # type: ignore
if not trigger:
event = ".".join([*parts[:2], "<__trigger__>"])

handler.__requirements__ = condition # type: ignore
handler.__trigger__ = trigger # type: ignore
try:
ChihweiLHBird marked this conversation as resolved.
Show resolved Hide resolved
# Attaching __requirements__ and __trigger__ to the handler
# is deprecated and will be removed in v23.6.
handler.__requirements__ = condition # type: ignore
handler.__trigger__ = trigger # type: ignore
except AttributeError:
pass

signal = super().add(
event,
Expand All @@ -232,6 +235,7 @@ def add( # type: ignore
signal.ctx.exclusive = exclusive
signal.ctx.trigger = trigger
signal.ctx.definition = event_definition
signal.extra.requirements = condition

return cast(Signal, signal)

Expand Down