bartender.context

Attributes

CurrentContext

Classes

Context

Context for web service.

Functions

build_context(→ Context)	Parses a plain configuration dict to a context instance.
get_context(→ Context)	Get context based on current request.
get_job_root_dir(→ pathlib.Path)	Get job root directory from context.
close_context(→ None)	Closes destinations in context.

Module Contents

class bartender.context.Context

Context for web service.

applications: dict[str, bartender.config.ApplicatonConfiguration]

destinations: dict[str, bartender.destinations.Destination]

job_root_dir: pathlib.Path

destination_picker: bartender.picker.DestinationPicker

bartender.context.build_context(config: bartender.config.Config) → Context

Parses a plain configuration dict to a context instance.

Parameters:

config (bartender.config.Config) – A plain configuration dict

Returns:

A config instance.

Return type:

Context

bartender.context.get_context(request: fastapi.Request) → Context

Get context based on current request.

Parameters:

request (fastapi.Request) – The current FastAPI request.

Returns:

The context.

Return type:

Context

bartender.context.CurrentContext

bartender.context.get_job_root_dir(context: CurrentContext) → pathlib.Path

Get job root directory from context.

Parameters:

context (CurrentContext) – The context.

Returns:

Directory in which all jobs are stored.

Return type:

pathlib.Path

async bartender.context.close_context(context: Context) → None

Closes destinations in context.

A destination might have a remote connection that needs to be cleaned-up.

Parameters:

context (Context) – The context.

Return type:

None