Skip to content

Better documented pattern for plugins using startup() to prevent server startup #2624

New issue
New issue
Closed
Closed
Better documented pattern for plugins using startup() to prevent server startup#2624
Labels
developer-experience
@simonw

Description

@simonw
simonw
opened on Jan 6, 2026

Currently suggests an assert, and that gives you an ugly traceback:

datasette/docs/plugin_hooks.rst

Lines 964 to 973 in 6fede23

Here is an example that validates required plugin configuration. The server will fail to start and show an error if the validation check fails:
.. code-block:: python
@hookimpl
def startup(datasette):
config = datasette.plugin_config("my-plugin") or {}
assert (
"required-setting" in config
), "my-plugin requires setting required-setting"

Metadata

Metadata

Assignees

No one assigned

    Labels

    developer-experience

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions