Source code for base_plugin

"""
This module defines a base class for creating plugins. Each plugin must inherit from the `Plugin` class
and implement the necessary methods defined in it.

Plugins are expected to perform specific operations as part of a larger application framework.
By inheriting from the `Plugin` base class, plugins are guaranteed to have a consistent interface
that the main application can interact with.
"""



class Plugin(object):
    """
    Base class for all plugins.

    Each plugin must inherit from this class and implement the required methods.
    This ensures that all plugins have a consistent interface, making it easier
    to integrate them into the main application.

    Attributes:
        description (str): A brief description of the plugin. Defaults to "UNKNOWN".
    """
    def __init__(self):
        """
        This is the base class that each plugin must inheritance from. Within this class you have to define the
        methods that all of your plugins must implement.
        """
        self.description = "UNKNOWN"



    def perform_operation(self, argument):
        """
        The method that we expect all plugins to implement. this is the framework our method will call.

        Args:
            argument (): The object widget from main application.

        Returns:
            None
        """
        raise NotImplementedError