betty.project.extension package

Subpackages

Module contents

Provide Betty’s extension API.

class betty.project.extension.ConfigurableExtension[source]

Bases: DefaultConfigurable[_ConfigurationT], Extension, Generic[_ConfigurationT]

A configurable extension.

async classmethod new_for_project(project: Project) Self[source]

Create a new instance using the given project.

class betty.project.extension.Dependencies[source]

Bases: AllRequirements

Check a dependent’s dependency requirements.

__init__(dependent: type[Extension], extension_id_to_type_mapping: PluginIdToTypeMapping[Extension], dependency_requirements: Sequence[Requirement])[source]

This is private. It MUST NOT be used anywhere outside its containing scope.

async classmethod new(dependent: type[Extension]) Self[source]

Create a new instance.

summary() Localizable[source]

Get the requirement’s human-readable summary.

betty.project.extension.EXTENSION_REPOSITORY: PluginRepository[Extension] = <betty.plugin.entry_point.EntryPointPluginRepository object>

The project extension plugin repository.

Read more about Extension plugins.

class betty.project.extension.Extension[source]

Bases: OrderedPlugin[Extension], DependentPlugin[Extension], CoreComponent, ProjectDependentFactory

Integrate optional functionality with Betty :py:class:`betty.project.Project`s.

Read more about Extension plugins.

To test your own subclasses, use betty.test_utils.project.extension.ExtensionTestBase.

__init__(project: Project)[source]
classmethod assets_directory_path() Path | None[source]

Return the path on disk where the extension’s assets are located.

This may be anywhere in your Python package.

async classmethod new_for_project(project: Project) Self[source]

Create a new instance using the given project.

property project: Project

The project this extension runs within.

register_event_handlers(registry: EventHandlerRegistry) None[source]

Register event handlers with the project.

async classmethod requirement() Requirement[source]

Define the requirement for this extension to be enabled.

This defaults to the extension’s dependencies.

class betty.project.extension.Theme[source]

Bases: Extension

An extension that is a front-end theme.

async betty.project.extension.sort_extension_type_graph(sorter: TopologicalSorter[type[Extension]], extension_types: Iterable[type[Extension]]) None[source]

Sort an extension graph.