diff options
| -rw-r--r-- | bot/decorators.py | 22 |
1 files changed, 22 insertions, 0 deletions
diff --git a/bot/decorators.py b/bot/decorators.py index f031d404..2520679a 100644 --- a/bot/decorators.py +++ b/bot/decorators.py @@ -1,3 +1,4 @@ +import functools import logging import random import typing @@ -27,6 +28,27 @@ class InMonthCheckFailure(CheckFailure): pass +def in_month_listener(*allowed_months: Month) -> typing.Callable: + """ + Shield a listener from being invoked outside of `allowed_months`. + + The check is performed against current UTC month. + """ + def decorator(listener: typing.Callable) -> typing.Callable: + @functools.wraps(listener) + async def guarded_listener(*args, **kwargs) -> None: + """Wrapped listener will abort if not in allowed month.""" + current_month = Month(datetime.utcnow().month) + + if current_month in allowed_months: + # Propagate return value although it should always be None + return await listener(*args, **kwargs) + else: + log.debug(f"Guarded {listener.__qualname__} from invoking in {current_month.name}") + return guarded_listener + return decorator + + def in_month(*allowed_months: Month) -> typing.Callable: """ Check whether the command was invoked in one of `enabled_months`. |