github/datasette
1
0
Fork 0
mirror of https://github.com/simonw/datasette.git synced 2025-12-10 16:51:24 +01:00
Code Issues Projects Releases Packages Wiki Activity

.plugin_config() can return None

Browse source
This commit is contained in:
Simon Willison 2022-04-28 13:29:11 -07:00 • committed by GitHub
commit 94a3171b01
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 6 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

4
docs/internals.rst
View file

@ -288,6 +288,10 @@ All databases are listed, irrespective of user permissions. This means that the
This method lets you read plugin configuration values that were set in ``metadata.json``. See :ref:`writing_plugins_configuration` for full details of how this method should be used.
The return value will be the value from the configuration file - usually a dictionary.
If the plugin is not configured the return value will be ``None``.
.. _datasette_render_template:
await .render_template(template, context=None, request=None)

2
docs/writing_plugins.rst
View file

@ -182,6 +182,8 @@ When you are writing plugins, you can access plugin configuration like this usin
This will return the ``{"latitude_column": "lat", "longitude_column": "lng"}`` in the above example.
If there is no configuration for that plugin, the method will return ``None``.
If it cannot find the requested configuration at the table layer, it will fall back to the database layer and then the root layer. For example, a user may have set the plugin configuration option like so::
{