2023-09-21 20:26:13 +00:00
|
|
|
import importlib
|
2023-08-30 22:12:24 +00:00
|
|
|
import os
|
2018-08-05 00:14:56 +00:00
|
|
|
import pluggy
|
2019-05-02 05:09:03 +00:00
|
|
|
import sys
|
2018-08-05 00:14:56 +00:00
|
|
|
from . import hookspecs
|
|
|
|
|
2023-09-21 19:42:15 +00:00
|
|
|
if sys.version_info >= (3, 9):
|
|
|
|
import importlib.resources as importlib_resources
|
|
|
|
else:
|
|
|
|
import importlib_resources
|
2023-09-21 21:58:39 +00:00
|
|
|
if sys.version_info >= (3, 10):
|
|
|
|
import importlib.metadata as importlib_metadata
|
|
|
|
else:
|
2023-09-21 20:26:13 +00:00
|
|
|
import importlib_metadata
|
2023-09-21 19:42:15 +00:00
|
|
|
|
|
|
|
|
Extract facet code out into a new plugin hook, closes #427 (#445)
Datasette previously only supported one type of faceting: exact column value counting.
With this change, faceting logic is extracted out into one or more separate classes which can implement other patterns of faceting - this is discussed in #427, but potential upcoming facet types include facet-by-date, facet-by-JSON-array, facet-by-many-2-many and more.
A new plugin hook, register_facet_classes, can be used by plugins to add in additional facet classes.
Each class must implement two methods: suggest(), which scans columns in the table to decide if they might be worth suggesting for faceting, and facet_results(), which executes the facet operation and returns results ready to be displayed in the UI.
2019-05-03 00:11:26 +00:00
|
|
|
DEFAULT_PLUGINS = (
|
|
|
|
"datasette.publish.heroku",
|
2019-05-03 13:59:01 +00:00
|
|
|
"datasette.publish.cloudrun",
|
Extract facet code out into a new plugin hook, closes #427 (#445)
Datasette previously only supported one type of faceting: exact column value counting.
With this change, faceting logic is extracted out into one or more separate classes which can implement other patterns of faceting - this is discussed in #427, but potential upcoming facet types include facet-by-date, facet-by-JSON-array, facet-by-many-2-many and more.
A new plugin hook, register_facet_classes, can be used by plugins to add in additional facet classes.
Each class must implement two methods: suggest(), which scans columns in the table to decide if they might be worth suggesting for faceting, and facet_results(), which executes the facet operation and returns results ready to be displayed in the UI.
2019-05-03 00:11:26 +00:00
|
|
|
"datasette.facets",
|
2021-12-17 19:02:14 +00:00
|
|
|
"datasette.filters",
|
2019-12-29 18:48:13 +00:00
|
|
|
"datasette.sql_functions",
|
2020-06-01 01:03:17 +00:00
|
|
|
"datasette.actor_auth_cookie",
|
2020-06-01 05:00:36 +00:00
|
|
|
"datasette.default_permissions",
|
2020-06-28 02:58:16 +00:00
|
|
|
"datasette.default_magic_parameters",
|
2020-10-29 22:01:38 +00:00
|
|
|
"datasette.blob_renderer",
|
2020-10-30 03:45:15 +00:00
|
|
|
"datasette.default_menu_links",
|
2022-07-17 23:24:39 +00:00
|
|
|
"datasette.handle_exception",
|
|
|
|
"datasette.forbidden",
|
2024-01-31 23:21:40 +00:00
|
|
|
"datasette.events",
|
Extract facet code out into a new plugin hook, closes #427 (#445)
Datasette previously only supported one type of faceting: exact column value counting.
With this change, faceting logic is extracted out into one or more separate classes which can implement other patterns of faceting - this is discussed in #427, but potential upcoming facet types include facet-by-date, facet-by-JSON-array, facet-by-many-2-many and more.
A new plugin hook, register_facet_classes, can be used by plugins to add in additional facet classes.
Each class must implement two methods: suggest(), which scans columns in the table to decide if they might be worth suggesting for faceting, and facet_results(), which executes the facet operation and returns results ready to be displayed in the UI.
2019-05-03 00:11:26 +00:00
|
|
|
)
|
2018-08-05 00:14:56 +00:00
|
|
|
|
|
|
|
pm = pluggy.PluginManager("datasette")
|
|
|
|
pm.add_hookspecs(hookspecs)
|
2019-05-02 05:09:03 +00:00
|
|
|
|
2023-08-30 22:12:24 +00:00
|
|
|
DATASETTE_LOAD_PLUGINS = os.environ.get("DATASETTE_LOAD_PLUGINS", None)
|
|
|
|
|
|
|
|
if not hasattr(sys, "_called_from_test") and DATASETTE_LOAD_PLUGINS is None:
|
2019-05-02 05:09:03 +00:00
|
|
|
# Only load plugins if not running tests
|
|
|
|
pm.load_setuptools_entrypoints("datasette")
|
2018-08-05 00:14:56 +00:00
|
|
|
|
2023-08-30 22:12:24 +00:00
|
|
|
# Load any plugins specified in DATASETTE_LOAD_PLUGINS")
|
|
|
|
if DATASETTE_LOAD_PLUGINS is not None:
|
|
|
|
for package_name in [
|
|
|
|
name for name in DATASETTE_LOAD_PLUGINS.split(",") if name.strip()
|
|
|
|
]:
|
|
|
|
try:
|
2023-09-21 20:26:13 +00:00
|
|
|
distribution = importlib_metadata.distribution(package_name)
|
2023-09-21 19:11:35 +00:00
|
|
|
entry_points = distribution.entry_points
|
|
|
|
for entry_point in entry_points:
|
|
|
|
if entry_point.group == "datasette":
|
2023-08-30 22:12:24 +00:00
|
|
|
mod = entry_point.load()
|
|
|
|
pm.register(mod, name=entry_point.name)
|
|
|
|
# Ensure name can be found in plugin_to_distinfo later:
|
|
|
|
pm._plugin_distinfo.append((mod, distribution))
|
2023-09-21 20:26:13 +00:00
|
|
|
except importlib_metadata.PackageNotFoundError:
|
2023-08-30 22:12:24 +00:00
|
|
|
sys.stderr.write("Plugin {} could not be found\n".format(package_name))
|
|
|
|
|
|
|
|
|
2018-08-05 00:14:56 +00:00
|
|
|
# Load default plugins
|
2018-08-28 07:36:22 +00:00
|
|
|
for plugin in DEFAULT_PLUGINS:
|
2018-08-05 00:14:56 +00:00
|
|
|
mod = importlib.import_module(plugin)
|
|
|
|
pm.register(mod, plugin)
|
2020-03-08 23:09:31 +00:00
|
|
|
|
|
|
|
|
|
|
|
def get_plugins():
|
|
|
|
plugins = []
|
|
|
|
plugin_to_distinfo = dict(pm.list_plugin_distinfo())
|
|
|
|
for plugin in pm.get_plugins():
|
|
|
|
static_path = None
|
|
|
|
templates_path = None
|
|
|
|
if plugin.__name__ not in DEFAULT_PLUGINS:
|
|
|
|
try:
|
2023-09-21 19:42:15 +00:00
|
|
|
if (importlib_resources.files(plugin.__name__) / "static").is_dir():
|
2023-09-21 19:11:35 +00:00
|
|
|
static_path = str(
|
2023-09-21 19:42:15 +00:00
|
|
|
importlib_resources.files(plugin.__name__) / "static"
|
2020-03-08 23:09:31 +00:00
|
|
|
)
|
2023-09-21 19:42:15 +00:00
|
|
|
if (importlib_resources.files(plugin.__name__) / "templates").is_dir():
|
2023-09-21 19:11:35 +00:00
|
|
|
templates_path = str(
|
2023-09-21 19:42:15 +00:00
|
|
|
importlib_resources.files(plugin.__name__) / "templates"
|
2020-03-08 23:09:31 +00:00
|
|
|
)
|
2023-09-21 19:11:35 +00:00
|
|
|
except (TypeError, ModuleNotFoundError):
|
|
|
|
# Caused by --plugins_dir= plugins
|
2020-03-08 23:09:31 +00:00
|
|
|
pass
|
|
|
|
plugin_info = {
|
|
|
|
"name": plugin.__name__,
|
|
|
|
"static_path": static_path,
|
|
|
|
"templates_path": templates_path,
|
2020-06-02 21:49:28 +00:00
|
|
|
"hooks": [h.name for h in pm.get_hookcallers(plugin)],
|
2020-03-08 23:09:31 +00:00
|
|
|
}
|
|
|
|
distinfo = plugin_to_distinfo.get(plugin)
|
|
|
|
if distinfo:
|
|
|
|
plugin_info["version"] = distinfo.version
|
2023-09-21 20:26:13 +00:00
|
|
|
plugin_info["name"] = distinfo.name or distinfo.project_name
|
2020-03-08 23:09:31 +00:00
|
|
|
plugins.append(plugin_info)
|
|
|
|
return plugins
|