betty.app package¶
Subpackages¶
- betty.app.extension package
- Module contents
ConfigurableExtension
CyclicDependencyError
Dependencies
Dependents
Extension
ExtensionDispatcher
ExtensionError
ExtensionTypeError
ExtensionTypeImportError
ExtensionTypeInvalidError
Extensions
ListExtensions
Theme
UserFacingExtension
build_extension_type_graph()
discover_extension_types()
format_extension_type()
get_extension_type()
get_extension_type_by_extension()
get_extension_type_by_name()
get_extension_type_by_type()
- Module contents
Module contents¶
Define Betty’s core application functionality.
- final class betty.app.App[source]¶
Bases:
Configurable
[AppConfiguration
]The Betty application.
- Parameters:
configuration (
betty.app.AppConfiguration
)cache_directory_path (
pathlib.Path
)project (
betty.project.Project
|None
)
- __init__(configuration: betty.app.AppConfiguration, cache_directory_path: pathlib.Path, project: betty.project.Project | None = None)[source]¶
- Parameters:
configuration (
betty.app.AppConfiguration
)cache_directory_path (
pathlib.Path
)project (
betty.project.Project
|None
)
- property assets: AssetRepository¶
The assets file system.
- property binary_file_cache: BinaryFileCache¶
The binary file cache.
- discover_extension_types() set[type[betty.app.extension.Extension]] [source]¶
Discover the available extension types.
- Return type:
- property dispatcher: Dispatcher¶
The event dispatcher.
- property extensions: Extensions¶
The enabled extensions.
- property http_client: ClientSession¶
The HTTP client.
- property jinja2_environment: Environment¶
The Jinja2 environment.
- property localizers: LocalizerRepository¶
The available localizers.
- classmethod new_from_app(cls, app: betty.app.App, *, project: betty.project.Project | None = None) collections.abc.AsyncIterator[Self] [source]¶
Create a new application from an existing application.
- Parameters:
app (
betty.app.App
)project (
betty.project.Project
|None
)
- Return type:
collections.abc.AsyncIterator
[typing.Self
]
- classmethod new_from_environment(cls, *, project: betty.project.Project | None = None) collections.abc.AsyncIterator[Self] [source]¶
Create a new application from the environment.
- Parameters:
project (
betty.project.Project
|None
)- Return type:
collections.abc.AsyncIterator
[typing.Self
]
- classmethod new_temporary(cls, *, project: betty.project.Project | None = None) collections.abc.AsyncIterator[Self] [source]¶
Creat a new, temporary, isolated application.
The application will not use any persistent caches, or leave any traces on the system.
- Parameters:
project (
betty.project.Project
|None
)- Return type:
collections.abc.AsyncIterator
[typing.Self
]
- property process_pool: Executor¶
The shared process pool.
Use this to run CPU/computationally-heavy tasks in other processes.
- property static_url_generator: StaticUrlGenerator¶
The static URL generator.
- property url_generator: LocalizedUrlGenerator¶
The (localized) URL generator.
- class betty.app.AppConfiguration[source]¶
Bases:
FileBasedConfiguration
Provide configuration for
betty.app.App
.- Parameters:
configuration_directory_path (
pathlib.Path
|None
)
- __init__(configuration_directory_path: pathlib.Path | None = None, *, locale: str | None = None)[source]¶
- Parameters:
configuration_directory_path (
pathlib.Path
|None
)
- dump() bool | int | float | str | None | Sequence[bool | int | float | str | None | Sequence[Dump] | Mapping[str, Dump]] | Mapping[str, bool | int | float | str | None | Sequence[Dump] | Mapping[str, Dump]] | type[betty.serde.dump.Void] [source]¶
Dump this instance to a portable format.
- Return type:
typing.Union
[bool
,int
,float
,str
,None
,typing.Sequence
[typing.Union
[bool
,int
,float
,str
,None
,typing.Sequence
[Dump],typing.Mapping
[str
, Dump]]],typing.Mapping
[str
,typing.Union
[bool
,int
,float
,str
,None
,typing.Sequence
[Dump],typing.Mapping
[str
, Dump]]],type
[betty.serde.dump.Void
]]