betty.plugin package

Submodules

Module contents

The Plugin API.

Plugins allow third-party code (e.g. your own Python package) to add functionality to Betty.

Read more at Plugins.

class betty.plugin.Plugin[source]

Bases: ABC

A plugin.

classmethod plugin_description() Localizable | None[source]

Get the human-readable long plugin description.

abstract classmethod plugin_id() str[source]

Get the plugin ID.

IDs are unique per plugin type: - A plugin repository MUST at most have a single plugin for any ID. - Different plugin repositories MAY each have a plugin with the same ID.

abstract classmethod plugin_label() Localizable[source]

Get the human-readable short plugin label.

exception betty.plugin.PluginError[source]

Bases: UserFacingError

Any error originating from the Plugin API.

betty.plugin.PluginId

A plugin ID is a string that meets these criteria: - At most 250 characters long. - Lowercase letters, numbers, and hyphens (-).

See betty.plugin.validate_plugin_id().

exception betty.plugin.PluginNotFound[source]

Bases: PluginError

Raised when a plugin cannot be found.

classmethod new(plugin_id: str) Self[source]

Create a new instance.

class betty.plugin.PluginRepository[source]

Bases: Generic[_PluginT], ABC

Discover and manage plugins.

abstract async get(plugin_id: str) type[_PluginT][source]

Get a single plugin by its ID.

Raises:

PluginNotFound – if no plugin can be found for the given ID.

async select() Sequence[type[_PluginT]][source]
async select(mixin_one: type[_PluginMixinOneT]) Sequence[type[_PluginT & _PluginMixinOneT]]
async select(mixin_one: type[_PluginMixinOneT], mixin_two: type[_PluginMixinTwoT]) Sequence[type[_PluginT & _PluginMixinOneT & _PluginMixinTwoT]]
async select(mixin_one: type[_PluginMixinOneT], mixin_two: type[_PluginMixinTwoT], mixin_three: type[_PluginMixinThreeT]) Sequence[type[_PluginT & _PluginMixinOneT & _PluginMixinTwoT & _PluginMixinThreeT]]

Select a subset of the known plugins.

When called without arguments, this returns all known plugins. When called with one or more arguments, this returns all known plugins that are also subclasses or all of the given mixins.

This method is overloaded to provide for the majority use case of at most three mixins, because when using *args: *Ts, we cannot unpack Ts into an basedtyping.Intersection return type.

betty.plugin.validate_plugin_id(plugin_id: str) TypeGuard[str][source]

Validate that a string is a plugin ID.