base

prefect.server.services.base

Classes

Service

Methods:

all_services

all_services(cls) -> Sequence[type[Self]]

Get list of all service classes

enabled

enabled(cls) -> bool

Whether the service is enabled

enabled_services

enabled_services(cls) -> list[type[Self]]

Get list of enabled service classes

environment_variable_name

environment_variable_name(cls) -> str

run_services

run_services(cls) -> NoReturn

Run enabled services until cancelled.

running

running(cls) -> AsyncGenerator[None, None]

A context manager that runs enabled services on entry and stops them on exit.

service_settings

service_settings(cls) -> ServicesBaseSetting

The Prefect setting that controls whether the service is enabled

start

start(self) -> NoReturn

Start running the service, which may run indefinitely

stop

stop(self) -> None

Stop the service

RunInEphemeralServers

A marker class for services that should run even when running an ephemeral server

Methods:

all_services

all_services(cls) -> Sequence[type[Self]]

Get list of all service classes

enabled

enabled(cls) -> bool

Whether the service is enabled

enabled_services

enabled_services(cls) -> list[type[Self]]

Get list of enabled service classes

environment_variable_name

environment_variable_name(cls) -> str

run_services

run_services(cls) -> NoReturn

Run enabled services until cancelled.

running

running(cls) -> AsyncGenerator[None, None]

A context manager that runs enabled services on entry and stops them on exit.

service_settings

service_settings(cls) -> ServicesBaseSetting

The Prefect setting that controls whether the service is enabled

start

start(self) -> NoReturn

Start running the service, which may run indefinitely

stop

stop(self) -> None

Stop the service

RunInWebservers

A marker class for services that should run when running a webserver

Methods:

all_services

all_services(cls) -> Sequence[type[Self]]

Get list of all service classes

enabled

enabled(cls) -> bool

Whether the service is enabled

enabled_services

enabled_services(cls) -> list[type[Self]]

Get list of enabled service classes

environment_variable_name

environment_variable_name(cls) -> str

run_services

run_services(cls) -> NoReturn

Run enabled services until cancelled.

running

running(cls) -> AsyncGenerator[None, None]

A context manager that runs enabled services on entry and stops them on exit.

service_settings

service_settings(cls) -> ServicesBaseSetting

The Prefect setting that controls whether the service is enabled

start

start(self) -> NoReturn

Start running the service, which may run indefinitely

stop

stop(self) -> None

Stop the service