aio_microservice.scheduler.extension

Attributes

SchedulerExtensionT
P
R

Classes

SchedulerExtensionImpl
SchedulerExtension	Helper class that provides a standard way to create an ABC using
SchedulerDecorator
interval
cron
crontab

Module Contents

class aio_microservice.scheduler.extension.SchedulerExtensionImpl(service)

Parameters:

service (SchedulerExtension)

property scheduler: apscheduler.schedulers.asyncio.AsyncIOScheduler

Return type:

apscheduler.schedulers.asyncio.AsyncIOScheduler

add_interval(fn, weeks=0, days=0, hours=0, minutes=0, seconds=0)

Parameters:

• fn (Callable[[], collections.abc.Awaitable[None]])

• weeks (int)

• days (int)

• hours (int)

• minutes (int)

• seconds (int)

Return type:

None

add_cron(fn, year=None, month=None, day=None, week=None, day_of_week=None, hour=None, minute=None, second=None)

Parameters:

• fn (Callable[[], collections.abc.Awaitable[None]])

• year (int | str | None)

• month (int | str | None)

• day (int | str | None)

• week (int | str | None)

• day_of_week (int | str | None)

• hour (int | str | None)

• minute (int | str | None)

• second (int | str | None)

Return type:

None

add_crontab(fn, expression)

Parameters:

• fn (Callable[[], collections.abc.Awaitable[None]])

• expression (str)

Return type:

None

class aio_microservice.scheduler.extension.SchedulerExtension

Bases: aio_microservice.core.abc.ExtensionABC

Helper class that provides a standard way to create an ABC using inheritance.

aio_microservice.scheduler.extension.SchedulerExtensionT

aio_microservice.scheduler.extension.P

aio_microservice.scheduler.extension.R

class aio_microservice.scheduler.extension.SchedulerDecorator

MARKER = '_scheduler_decorator'

class aio_microservice.scheduler.extension.interval

Bases: SchedulerDecorator

weeks: int = 0

days: int = 0

hours: int = 0

minutes: int = 0

seconds: int = 0

__call__(fn)

Parameters:

fn (Callable[typing_extensions.Concatenate[SchedulerExtensionT, P], R])

Return type:

Callable[typing_extensions.Concatenate[SchedulerExtensionT, P], R]

class aio_microservice.scheduler.extension.cron

Bases: SchedulerDecorator

year: int | str | None = None

month: int | str | None = None

day: int | str | None = None

week: int | str | None = None

day_of_week: int | str | None = None

hour: int | str | None = None

minute: int | str | None = None

second: int | str | None = None

__call__(fn)

Parameters:

fn (Callable[typing_extensions.Concatenate[SchedulerExtensionT, P], R])

Return type:

Callable[typing_extensions.Concatenate[SchedulerExtensionT, P], R]

class aio_microservice.scheduler.extension.crontab

Bases: SchedulerDecorator

expression: str

__call__(fn)

Parameters:

fn (Callable[typing_extensions.Concatenate[SchedulerExtensionT, P], R])

Return type:

Callable[typing_extensions.Concatenate[SchedulerExtensionT, P], R]