timers

该模块提供一些便捷的 Timer

crontabify(pattern, base=None)

使用类似 crontab 的方式生成计时器

Parameters:

Name	Type	Description	Default
pattern	str	时间模式	required
base	Optional[TimeObject]	开始时间. 默认为 datetime.now().	None

Yields:

Type	Description
datetime	生成的 datetime.

Source code in src/graia/scheduler/timers.py

def crontabify(pattern: str, base: Optional[TimeObject] = None) -> Ret:
    """使用类似 crontab 的方式生成计时器

    Args:
        pattern (str): 时间模式
        base (Optional[TimeObject], optional): 开始时间. 默认为 datetime.now().

    Yields:
        (datetime): 生成的 datetime.
    """
    base = to_datetime(base) if base else datetime.now()
    crontab_iter = croniter(pattern, base)
    while True:
        yield crontab_iter.get_next(datetime)

every(*, base=None, **kwargs)

一个简便的 datetime 生成器.

Parameters:

Name	Type	Description	Default
base	Optional[TimeObject]	若为 None (默认), 则会相对于当前时间推算. 否则基于 base 推算.	None

Yields:

Type	Description
datetime	生成的 datetime.

Source code in src/graia/scheduler/timers.py

def every(*, base: Optional[TimeObject] = None, **kwargs) -> Ret:
    """一个简便的 datetime 生成器.

    Args:
        base (Optional[TimeObject], optional): 若为 None (默认), 则会相对于当前时间推算. 否则基于 base 推算.

    Yields:
        (datetime): 生成的 datetime.
    """
    if base is None:
        while True:
            yield datetime.now() + timedelta(**kwargs)
    else:
        current = to_datetime(base)
        while True:
            current += timedelta(**kwargs)
            yield current

every_custom_hours(hours, *, base=None)

每 hours 小时执行一次

Parameters:

Name	Type	Description	Default
hours	int	距离下一次执行的时间间隔, 单位为小时	required
base	Optional[TimeObject]	若为 None (默认), 则会相对于当前时间推算. 否则基于 base 推算.	None

Yields:

Type	Description
datetime	生成的 datetime.

Source code in src/graia/scheduler/timers.py

def every_custom_hours(hours: int, *, base: Optional[TimeObject] = None) -> Ret:
    """每 hours 小时执行一次

    Args:
        hours (int): 距离下一次执行的时间间隔, 单位为小时
        base (Optional[TimeObject], optional): 若为 None (默认), 则会相对于当前时间推算. 否则基于 base 推算.

    Yields:
        (datetime): 生成的 datetime.
    """
    yield from every(hours=hours, base=base)

every_custom_minutes(minutes, *, base=None)

每 minutes 分执行一次

Parameters:

Name	Type	Description	Default
minutes	int	距离下一次执行的时间间隔, 单位为分	required
base	Optional[TimeObject]	若为 None (默认), 则会相对于当前时间推算. 否则基于 base 推算.	None

Yields:

Type	Description
datetime	生成的 datetime.

Source code in src/graia/scheduler/timers.py

def every_custom_minutes(minutes: int, *, base: Optional[TimeObject] = None) -> Ret:
    """每 minutes 分执行一次

    Args:
        minutes (int): 距离下一次执行的时间间隔, 单位为分
        base (Optional[TimeObject], optional): 若为 None (默认), 则会相对于当前时间推算. 否则基于 base 推算.

    Yields:
        (datetime): 生成的 datetime.
    """
    yield from every(minutes=minutes, base=base)

every_custom_seconds(seconds, *, base=None)

每 seconds 秒执行一次

Parameters:

Name	Type	Description	Default
seconds	int	距离下一次执行的时间间隔, 单位为秒	required
base	Optional[TimeObject]	若为 None (默认), 则会相对于当前时间推算. 否则基于 base 推算.	None

Yields:

Type	Description
datetime	生成的 datetime.

Source code in src/graia/scheduler/timers.py

def every_custom_seconds(seconds: int, *, base: Optional[TimeObject] = None) -> Ret:
    """每 seconds 秒执行一次

    Args:
        seconds (int): 距离下一次执行的时间间隔, 单位为秒
        base (Optional[TimeObject], optional): 若为 None (默认), 则会相对于当前时间推算. 否则基于 base 推算.

    Yields:
        (datetime): 生成的 datetime.
    """
    yield from every(seconds=seconds, base=base)

every_hour(*, base=None)

每小时执行一次.

Parameters:

Name	Type	Description	Default
base	Optional[TimeObject]	若为 None (默认), 则会相对于当前时间推算. 否则基于 base 推算.	None

Yields:

Type	Description
datetime	生成的 datetime.

Source code in src/graia/scheduler/timers.py

def every_hour(*, base: Optional[TimeObject] = None):
    """每小时执行一次.

    Args:
        base (Optional[TimeObject], optional): 若为 None (默认), 则会相对于当前时间推算. 否则基于 base 推算.

    Yields:
        (datetime): 生成的 datetime.
    """
    yield from every(hours=1, base=base)

every_minute(*, base=None)

每分钟执行一次.

Parameters:

Name	Type	Description	Default
base	Optional[TimeObject]	若为 None (默认), 则会相对于当前时间推算. 否则基于 base 推算.	None

Yields:

Type	Description
datetime	生成的 datetime.

Source code in src/graia/scheduler/timers.py

def every_minute(*, base: Optional[TimeObject] = None) -> Ret:
    """每分钟执行一次.

    Args:
        base (Optional[TimeObject], optional): 若为 None (默认), 则会相对于当前时间推算. 否则基于 base 推算.

    Yields:
        (datetime): 生成的 datetime.
    """
    yield from every(minutes=1, base=base)

every_second(*, base=None)

每秒钟执行一次

Parameters:

Name	Type	Description	Default
base	Optional[TimeObject]	若为 None (默认), 则会相对于当前时间推算. 否则基于 base 推算.	None

Yields:

Type	Description
datetime	生成的 datetime.

Source code in src/graia/scheduler/timers.py

def every_second(*, base: Optional[TimeObject] = None) -> Ret:
    """每秒钟执行一次

    Args:
        base (Optional[TimeObject], optional): 若为 None (默认), 则会相对于当前时间推算. 否则基于 base 推算.

    Yields:
        (datetime): 生成的 datetime.
    """
    yield from every(seconds=1, base=base)