mirror of
https://github.com/solero/houdini.git
synced 2024-11-21 21:17:21 +00:00
Plugin abstract class interface
This commit is contained in:
parent
40d897e7e2
commit
60a808beb6
@ -0,0 +1,29 @@
|
||||
from abc import ABC
|
||||
from abc import abstractmethod
|
||||
|
||||
|
||||
class IPlugin(ABC):
|
||||
"""
|
||||
Plugin interface which all plugins *must* implement.
|
||||
"""
|
||||
|
||||
@property
|
||||
@abstractmethod
|
||||
def author(self):
|
||||
"""The plugin's author which is usually a nickname and an e-mail address."""
|
||||
|
||||
@property
|
||||
@abstractmethod
|
||||
def version(self):
|
||||
"""The version of the plugin."""
|
||||
|
||||
@property
|
||||
@abstractmethod
|
||||
def description(self):
|
||||
"""Short summary of the plugin's intended purpose."""
|
||||
|
||||
@abstractmethod
|
||||
async def ready(self):
|
||||
"""
|
||||
Called when the plugin is ready to function.
|
||||
"""
|
Loading…
Reference in New Issue
Block a user