Source code for openalea.vpltk.plugin

# -*- python -*-
#
#       Plugin System for vpltk
# 
#       OpenAlea.VPLTk: Virtual Plants Lab Toolkit
#
#       Copyright 2013 INRIA - CIRAD - INRA
#
#       File author(s): Christophe Pradal <christophe.pradal@inria.fr>
#
#       File contributor(s):
#
#       Distributed under the Cecill-C License.
#       See accompanying file LICENSE.txt or copy at
#           http://www.cecill.info/licences/Licence_CeCILL-C_V1-en.html
#
#       OpenAlea WebSite : http://openalea.gforge.inria.fr
#
###############################################################################
__revision__ = ""

"""
Plugin fundamentals are:
  - Dicovery
  - Registration
  - EntryPoint


"""

import pkg_resources

[docs]def discover(group, name=None):
    """
    Return all Plugin objects from group.

    :Parameters:
        - group : the name of a plugin group

    :Returns:
        - plugins : dict of name:plugin

    :todo: check that the same name is not used by several plugins 
    """	

    plugin_map = {ep.name:ep for ep in pkg_resources.iter_entry_points(group,name)} 
    return plugin_map

[docs]def iter_plugins(group, name=None):
    for ep in pkg_resources.iter_entry_points(group, name):
        try:
            yield ep.load()
        except ImportError:
            pass

[docs]class Plugin(object):
    """ Define a Plugin from an entry point. """

    def __init__(self, epoint):
        self.ep = epoint

    @property
[docs]    def name(self):
        return self.ep.name

    @property
[docs]    def module_name(self):
        return self.ep.module_name

    @property
[docs]    def dist(self):
        return self.ep.dist

[docs]    def load(self, *args, **kwds):
        return self.ep.load(*args,**kwds)