"""Output function out.clear_triggers."""
import re
from ....processor import PAction
from ....processor.context import Context
from .out import Out
[docs]
class ClearQueue(Out):
"""Class for `out.clear_queue` function.
Removes any items from the queue that were previously queued
using the out.enqueue_*() functions.
"""
min_args = 0
max_args = 0
match_re = re.compile(r"(out\.clear_queue)\((.*)\)$")
value_types = tuple()
[docs]
def execute(self, context: Context) -> PAction:
"""Clear enqueued tokens.
:param context: Current context object.
:returns: PAction.CONTINUE
"""
context.queue.clear_triggers()
return PAction.CONTINUE