bayesline.api

bayesline.api#

Description of the public-facing API for bayesline.

bayesline.api.equity#

Classes#

BayeslineApi()

Abstract base class for Bayesline API operations.

AsyncBayeslineApi()

Abstract base class for Bayesline API operations.

EmptySettingsMenu

Empty settings menu implementation.

IncidentSummary

A summary of incidents within a date and index range.

IncidentSummaryItem

A single incident summary item.

IncidentsServiceApi()

Gives access to system incidents.

AsyncIncidentsServiceApi()

Gives access to system incidents.

InvalidSettingsError

Exception raised when settings are invalid.

RawSettings

Raw settings data structure.

ReadOnlyRegistry()

Abstract base class for read-only registries.

Registry()

Abstract base class for writable registries.

AsyncRegistry()

Abstract base class for async writable registries.

AsyncReadOnlyRegistry()

Abstract base class for read-only registries.

Settings

Base class for all settings objects.

SettingsMenu

Abstract base class for settings menus.

SettingsMetaData

Metadata for settings objects.

SettingsRegistry()

Registry for settings with validation against a settings menu.

AsyncSettingsRegistry()

Registry for settings with validation against a settings menu.

AsyncSettingsResolver()

Abstract base class for async settings resolvers.

SettingsTypeMetaData(references[, extractor])

Metadata for settings type references.

Task()

Abstract base class representing a task that produces a result of type T.

AsyncTask()

Abstract base class representing a task that produces a result of type T.

TaskError

Exception raised when a task operation fails.

TaskProgress

The progress of a task.

TaskResponse

Response model for task operations.

TaskState(value[, names, module, qualname, ...])

The state of a task.

TasksApi()

Abstract base class for synchronous task API operations.

AsyncTasksApi()

Abstract base class for synchronous task API operations.

PermissionsApi()

Abstract base class for synchronous ACL-based permissionining API operations.

AsyncPermissionsApi()

Abstract base class for asynchronous ACL-based permissionining API operations.