-
Notifications
You must be signed in to change notification settings - Fork 157
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: Support state backend core setting extensions
- Loading branch information
1 parent
25da80a
commit 112fce0
Showing
9 changed files
with
263 additions
and
25 deletions.
There are no files selected for viewing
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,54 @@ | ||
"""Make a feature pluggable with packaging plugins.""" | ||
|
||
from __future__ import annotations | ||
|
||
import sys | ||
import typing as t | ||
from functools import cached_property | ||
|
||
if sys.version_info >= (3, 12): | ||
from importlib.metadata import EntryPoints, entry_points | ||
else: | ||
from importlib_metadata import EntryPoints, entry_points | ||
|
||
T = t.TypeVar("T") | ||
|
||
|
||
class Pluggable(t.Generic[T]): | ||
"""Make a feature pluggable with packaging plugins.""" | ||
|
||
def __init__(self, entry_point_group: str): | ||
"""Create a new pluggable feature. | ||
Args: | ||
entry_point_group: The entry point group for the feature. | ||
""" | ||
self.entry_point_group = entry_point_group | ||
|
||
@cached_property | ||
def meltano_plugins(self) -> EntryPoints: | ||
"""List available plugins. | ||
Returns: | ||
List of available plugins. | ||
""" | ||
return entry_points(group=self.entry_point_group) | ||
|
||
def get_all_meltano_plugins(self) -> dict[str, T]: | ||
"""Get all plugins. | ||
Returns: | ||
All plugins. | ||
""" | ||
return {ep.name: ep.load() for ep in self.meltano_plugins} | ||
|
||
def get_meltano_plugin(self, name: str) -> T: | ||
"""Get a plugin by name. | ||
Args: | ||
name: The name of the plugin. | ||
Returns: | ||
The plugged object. | ||
""" | ||
return self.meltano_plugins[name].load() |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
from __future__ import annotations | ||
|
||
|
||
class MyPlugin: | ||
"""Dummy plugin.""" |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
from __future__ import annotations | ||
|
||
from meltano.core.state_store import StateStoreManager | ||
|
||
|
||
class DummyStateStoreManager(StateStoreManager): | ||
label: str = "Dummy state store manager" | ||
|
||
def __init__(self, **kwargs): ... # noqa: WPS428 | ||
|
||
def set(self, state): ... # noqa: WPS428 | ||
|
||
def get(self, state_id): ... # noqa: WPS428 | ||
|
||
def clear(self, state_id): ... # noqa: WPS428 | ||
|
||
def get_state_ids(self, _pattern=None): | ||
return () # pragma: no cover | ||
|
||
def acquire_lock(self, state_id): ... # noqa: WPS428 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,43 @@ | ||
from __future__ import annotations | ||
|
||
import sys | ||
import typing as t | ||
|
||
from fixtures.custom_pluggable import MyPlugin | ||
from meltano.core.behavior.pluggable import Pluggable | ||
|
||
if sys.version_info >= (3, 12): | ||
from importlib.metadata import EntryPoint, EntryPoints | ||
else: | ||
from importlib_metadata import EntryPoint, EntryPoints | ||
|
||
if t.TYPE_CHECKING: | ||
import pytest | ||
|
||
|
||
def test_entry_point_group(): | ||
"""Test that the entry point group is set correctly.""" | ||
pluggable = Pluggable("meltano.custom_feature") | ||
|
||
assert pluggable.entry_point_group == "meltano.custom_feature" | ||
assert not pluggable.meltano_plugins | ||
|
||
|
||
def test_entry_points(monkeypatch: pytest.MonkeyPatch): | ||
"""Test that the entry points are loaded correctly.""" | ||
pluggable: Pluggable[object] = Pluggable("meltano.custom_feature") | ||
|
||
entry_points = EntryPoints( | ||
( | ||
EntryPoint( | ||
value="fixtures.custom_pluggable:MyPlugin", | ||
name="custom", | ||
group="meltano.custom_feature", | ||
), | ||
), | ||
) | ||
|
||
with monkeypatch.context() as m: | ||
m.setattr(pluggable, "meltano_plugins", entry_points) | ||
plugin = pluggable.get_meltano_plugin("custom") | ||
assert plugin == MyPlugin |
Oops, something went wrong.