mirror of
https://github.com/simonw/sqlite-utils.git
synced 2026-07-23 17:34:32 +02:00
f448b61f5e* fix: defer plugin entrypoint loading until runtime Fixes simonw/sqlite-utils#713 * Lazy-load plugins when listing them Keep plugin entrypoints from loading at module import time, but preserve the existing behavior of get_plugins() by loading entrypoints the first time plugins are listed outside tests. --------- Co-authored-by: Simon Willison <swillison@gmail.com>
128 lines
3.5 KiB
Python
128 lines
3.5 KiB
Python
from click.testing import CliRunner
|
|
import click
|
|
import importlib
|
|
import pytest
|
|
import sys
|
|
from sqlite_utils import cli, Database, hookimpl, plugins
|
|
|
|
|
|
def _supports_pragma_function_list():
|
|
db = Database(memory=True)
|
|
try:
|
|
db.execute("select * from pragma_function_list()")
|
|
return True
|
|
except Exception:
|
|
return False
|
|
finally:
|
|
db.close()
|
|
|
|
|
|
def test_get_plugins_loads_setuptools_entrypoints_once(monkeypatch):
|
|
calls = []
|
|
monkeypatch.delattr(sys, "_called_from_test", raising=False)
|
|
monkeypatch.setattr(plugins, "_plugins_loaded", False)
|
|
monkeypatch.setattr(
|
|
plugins.pm,
|
|
"load_setuptools_entrypoints",
|
|
lambda group: calls.append(group) or 0,
|
|
)
|
|
|
|
plugins.get_plugins()
|
|
plugins.get_plugins()
|
|
|
|
assert calls == ["sqlite_utils"]
|
|
|
|
|
|
def test_get_plugins_does_not_load_setuptools_entrypoints_in_tests(monkeypatch):
|
|
calls = []
|
|
monkeypatch.setattr(sys, "_called_from_test", True, raising=False)
|
|
monkeypatch.setattr(plugins, "_plugins_loaded", False)
|
|
monkeypatch.setattr(
|
|
plugins.pm,
|
|
"load_setuptools_entrypoints",
|
|
lambda group: calls.append(group) or 0,
|
|
)
|
|
|
|
assert plugins.get_plugins() == []
|
|
assert calls == []
|
|
|
|
|
|
def test_register_commands():
|
|
importlib.reload(cli)
|
|
assert plugins.get_plugins() == []
|
|
|
|
class HelloWorldPlugin:
|
|
__name__ = "HelloWorldPlugin"
|
|
|
|
@hookimpl
|
|
def register_commands(self, cli):
|
|
@cli.command(name="hello-world")
|
|
def hello_world():
|
|
"Print hello world"
|
|
click.echo("Hello world!")
|
|
|
|
try:
|
|
plugins.pm.register(HelloWorldPlugin(), name="HelloWorldPlugin")
|
|
importlib.reload(cli)
|
|
|
|
assert plugins.get_plugins() == [
|
|
{"name": "HelloWorldPlugin", "hooks": ["register_commands"]}
|
|
]
|
|
|
|
runner = CliRunner()
|
|
result = runner.invoke(cli.cli, ["hello-world"])
|
|
assert result.exit_code == 0
|
|
assert result.output == "Hello world!\n"
|
|
|
|
finally:
|
|
plugins.pm.unregister(name="HelloWorldPlugin")
|
|
importlib.reload(cli)
|
|
assert plugins.get_plugins() == []
|
|
|
|
|
|
@pytest.mark.skipif(
|
|
not _supports_pragma_function_list(),
|
|
reason="Needs SQLite version that supports pragma_function_list()",
|
|
)
|
|
def test_prepare_connection():
|
|
importlib.reload(cli)
|
|
assert plugins.get_plugins() == []
|
|
|
|
class HelloFunctionPlugin:
|
|
__name__ = "HelloFunctionPlugin"
|
|
|
|
@hookimpl
|
|
def prepare_connection(self, conn):
|
|
conn.create_function("hello", 1, lambda name: f"Hello, {name}!")
|
|
|
|
db = Database(memory=True)
|
|
|
|
def _functions(db):
|
|
return [
|
|
row[0]
|
|
for row in db.execute(
|
|
"select distinct name from pragma_function_list() order by 1"
|
|
).fetchall()
|
|
]
|
|
|
|
assert "hello" not in _functions(db)
|
|
|
|
try:
|
|
plugins.pm.register(HelloFunctionPlugin(), name="HelloFunctionPlugin")
|
|
|
|
assert plugins.get_plugins() == [
|
|
{"name": "HelloFunctionPlugin", "hooks": ["prepare_connection"]}
|
|
]
|
|
|
|
db = Database(memory=True)
|
|
assert "hello" in _functions(db)
|
|
result = db.execute('select hello("world")').fetchone()[0]
|
|
assert result == "Hello, world!"
|
|
|
|
# Test execute_plugins=False
|
|
db2 = Database(memory=True, execute_plugins=False)
|
|
assert "hello" not in _functions(db2)
|
|
|
|
finally:
|
|
plugins.pm.unregister(name="HelloFunctionPlugin")
|
|
assert plugins.get_plugins() == []
|