Skip to content

discovery

Entry point-based plugin discovery.

This module handles discovering plugins registered via setuptools entry points. Third-party packages can register plugins in their pyproject.toml.

Classes

Functions

clear_discovery_cache 

clear_discovery_cache() -> None

Clear the cached entry point plugins, forcing a rediscovery on next access.

Source code in snakesee/plugins/discovery.py 
100
101
102
103
104
105
def clear_discovery_cache() -> None:
    """Clear the cached entry point plugins, forcing a rediscovery on next access."""
    global _entry_point_plugins
    global _entry_point_version_hash
    _entry_point_plugins = None
    _entry_point_version_hash = 0

discover_entry_point_plugins 

discover_entry_point_plugins(force_reload: bool = False) -> list[ToolProgressPlugin]

Discover plugins registered via setuptools entry points.

Third-party packages can register plugins by adding an entry point in their pyproject.toml:

[project.entry-points."snakesee.plugins"]
my_tool = "my_package.plugins:MyToolPlugin"

Parameters:

Name Type Description Default
force_reload bool

If True, re-discover plugins even if cached.

 False

Returns:

Type Description
list[ToolProgressPlugin]

List of discovered plugin instances.
Source code in snakesee/plugins/discovery.py 
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
def discover_entry_point_plugins(
    force_reload: bool = False,
) -> list[ToolProgressPlugin]:
    """
    Discover plugins registered via setuptools entry points.

    Third-party packages can register plugins by adding an entry point
    in their pyproject.toml:

        [project.entry-points."snakesee.plugins"]
        my_tool = "my_package.plugins:MyToolPlugin"

    Args:
        force_reload: If True, re-discover plugins even if cached.

    Returns:
        List of discovered plugin instances.
    """
    global _entry_point_plugins
    global _entry_point_version_hash

    version_hash = _compute_version_hash()

    # Return cached plugins if valid and not forcing reload
    if (
        _entry_point_plugins is not None
        and not force_reload
        and _entry_point_version_hash == version_hash
    ):
        return _entry_point_plugins

    plugins: list[ToolProgressPlugin] = []

    try:
        # Python 3.10+ style
        eps = entry_points(group=ENTRY_POINT_GROUP)
        for ep in eps:
            try:
                plugin_class = ep.load()
                if isinstance(plugin_class, type) and issubclass(plugin_class, ToolProgressPlugin):
                    plugin_instance = plugin_class()
                    # Validate the plugin before adding it
                    metadata = validate_plugin(plugin_instance, f"entry_point:{ep.name}")
                    if metadata is not None:
                        plugins.append(plugin_instance)
            except (ImportError, TypeError, AttributeError) as e:
                logger.debug("Failed to load entry point plugin %s: %s", ep.name, e)
                continue
    except (TypeError, OSError) as e:
        logger.debug("Error discovering entry points: %s", e)

    _entry_point_plugins = plugins
    _entry_point_version_hash = version_hash
    return plugins