Utility to help with "Datasette no longer accepts plugin configuration in --metadata"

[simonw]

The first utility in this class will help plugins that want to work against Datasette before and after this change: simonw/datasette@3d6d1e3

def fail_if_plugins_in_metadata(metadata: dict, filename=None):
    """If plugin config is inside metadata, raise an Exception"""
    if metadata is not None and metadata.get("plugins") is not None:
        suggested_extension = (
            ".yaml"
            if filename is not None
            and (filename.endswith(".yaml") or filename.endswith(".yml"))
            else ".json"
        )
        raise Exception(
            f'Datasette no longer accepts plugin configuration in --metadata. Move your "plugins" configuration blocks to a separate file - we suggest calling that datasette.{suggested_extension} - and start Datasette with datasette -c datasette.{suggested_extension}. See https://docs.datasette.io/en/latest/configuration.html for more details.'
        )
    return metadata

[simonw]

I'm going to do this with a custom Datasette subclass:

from datasette_test import Datasette

ds = Datasette(metadata={}, plugin_config={...})

This will change plugin_config into either metadata["plugins"] = ... or config["plugins"] = ... depending on the Datasette version.

It's going to attempt to import datasette.utils.fail_if_plugins_in_metadata to check if it should act or not.

[simonw]

Released as first version, details here:

• Upgrade to pyproject.toml and pypa/gh-action-pypi-publish simonw/python-lib#6