|
| 1 | +from dataclasses import dataclass, field |
| 2 | +from enum import Enum, auto |
| 3 | +from typing import Any, Dict, List, Optional, Type, TypeVar, Generic, Callable |
| 4 | +from pathlib import Path |
| 5 | +import importlib |
| 6 | +import inspect |
| 7 | +import logging |
| 8 | + |
| 9 | +logger = logging.getLogger(__name__) |
| 10 | + |
| 11 | +class PluginState(Enum): |
| 12 | + """Represents the state of a plugin.""" |
| 13 | + UNLOADED = auto() |
| 14 | + LOADED = auto() |
| 15 | + ENABLED = auto() |
| 16 | + DISABLED = auto() |
| 17 | + ERROR = auto() |
| 18 | + |
| 19 | +@dataclass |
| 20 | +class PluginMetadata: |
| 21 | + """Metadata for a plugin.""" |
| 22 | + name: str |
| 23 | + version: str |
| 24 | + description: str = "" |
| 25 | + author: str = "" |
| 26 | + license: str = "MIT" |
| 27 | + requires: List[str] = field(default_factory=list) # List of required plugin names |
| 28 | + conflicts: List[str] = field(default_factory=list) # List of conflicting plugin names |
| 29 | + python_requires: str = ">=3.9" # Python version requirement |
| 30 | + dependencies: Dict[str, str] = field(default_factory=dict) # Package dependencies |
| 31 | + |
| 32 | + @classmethod |
| 33 | + def from_dict(cls, data: Dict[str, Any]) -> 'PluginMetadata': |
| 34 | + """Create PluginMetadata from a dictionary.""" |
| 35 | + return cls(**{ |
| 36 | + k: v for k, v in data.items() |
| 37 | + if k in inspect.signature(cls).parameters |
| 38 | + }) |
| 39 | + |
| 40 | +class BasePlugin: |
| 41 | + """Base class for all plugins.""" |
| 42 | + |
| 43 | + def __init__(self): |
| 44 | + self._state = PluginState.UNLOADED |
| 45 | + self._metadata: Optional[PluginMetadata] = None |
| 46 | + self._module = None |
| 47 | + self._path: Optional[Path] = None |
| 48 | + self._resources = {} |
| 49 | + |
| 50 | + @property |
| 51 | + def state(self) -> PluginState: |
| 52 | + """Get the current state of the plugin.""" |
| 53 | + return self._state |
| 54 | + |
| 55 | + @property |
| 56 | + def metadata(self) -> PluginMetadata: |
| 57 | + """Get the plugin metadata.""" |
| 58 | + if self._metadata is None: |
| 59 | + raise ValueError("Plugin metadata not loaded") |
| 60 | + return self._metadata |
| 61 | + |
| 62 | + @property |
| 63 | + def name(self) -> str: |
| 64 | + """Get the plugin name.""" |
| 65 | + return self.metadata.name |
| 66 | + |
| 67 | + async def load(self) -> None: |
| 68 | + """Load the plugin.""" |
| 69 | + if self._state != PluginState.UNLOADED: |
| 70 | + raise RuntimeError(f"Plugin {self.name} is already loaded") |
| 71 | + |
| 72 | + self._state = PluginState.LOADED |
| 73 | + logger.info(f"Loaded plugin: {self.name}") |
| 74 | + |
| 75 | + async def unload(self) -> None: |
| 76 | + """Unload the plugin and clean up resources.""" |
| 77 | + if self._state == PluginState.UNLOADED: |
| 78 | + return |
| 79 | + |
| 80 | + if hasattr(self, 'on_disable'): |
| 81 | + await self.on_disable() |
| 82 | + |
| 83 | + # Clean up resources |
| 84 | + for resource in self._resources.values(): |
| 85 | + if hasattr(resource, 'close'): |
| 86 | + if inspect.iscoroutinefunction(resource.close): |
| 87 | + await resource.close() |
| 88 | + else: |
| 89 | + resource.close() |
| 90 | + |
| 91 | + self._resources.clear() |
| 92 | + self._state = PluginState.UNLOADED |
| 93 | + logger.info(f"Unloaded plugin: {self.name}") |
| 94 | + |
| 95 | + async def enable(self) -> None: |
| 96 | + """Enable the plugin.""" |
| 97 | + if self._state != PluginState.LOADED: |
| 98 | + raise RuntimeError(f"Cannot enable plugin {self.name} in state {self._state}") |
| 99 | + |
| 100 | + if hasattr(self, 'on_enable'): |
| 101 | + await self.on_enable() |
| 102 | + |
| 103 | + self._state = PluginState.ENABLED |
| 104 | + logger.info(f"Enabled plugin: {self.name}") |
| 105 | + |
| 106 | + async def disable(self) -> None: |
| 107 | + """Disable the plugin.""" |
| 108 | + if self._state != PluginState.ENABLED: |
| 109 | + return |
| 110 | + |
| 111 | + if hasattr(self, 'on_disable'): |
| 112 | + await self.on_disable() |
| 113 | + |
| 114 | + self._state = PluginState.DISABLED |
| 115 | + logger.info(f"Disabled plugin: {self.name}") |
| 116 | + |
| 117 | + def register_resource(self, name: str, resource: Any) -> None: |
| 118 | + """Register a resource that needs cleanup.""" |
| 119 | + self._resources[name] = resource |
| 120 | + |
| 121 | + def get_resource(self, name: str) -> Any: |
| 122 | + """Get a registered resource.""" |
| 123 | + return self._resources.get(name) |
| 124 | + |
| 125 | + # Lifecycle hooks (to be overridden by plugins) |
| 126 | + async def on_load(self) -> None: |
| 127 | + """Called when the plugin is loaded.""" |
| 128 | + pass |
| 129 | + |
| 130 | + async def on_enable(self) -> None: |
| 131 | + """Called when the plugin is enabled.""" |
| 132 | + pass |
| 133 | + |
| 134 | + async def on_disable(self) -> None: |
| 135 | + """Called when the plugin is disabled.""" |
| 136 | + pass |
| 137 | + |
| 138 | + async def on_unload(self) -> None: |
| 139 | + """Called when the plugin is unloaded.""" |
| 140 | + pass |
0 commit comments