Skip to main content

A framework for creating and importing plugins

Project description

Documentation Status GitHub Actions Status Coverage Status
PyPI Package latest release Supported versions Supported implementations
Fedora version support EPEL version support

Overview

Pluginlib makes creating plugins for your project simple.

Features

  • Plugins are validated when they are imported

  • Plugins can be loaded through different mechanisms (modules, filesystem paths, entry points)

  • Multiple versions of the same plugin are supported (The newest one is used by default)

  • Plugins can be blacklisted by type, name, or version

  • Multiple plugin groups are supported so one program can use multiple sets of plugins that won’t conflict

  • Plugins support conditional loading (examples: os, version, installed software, etc)

  • Once loaded, plugins can be accessed through dictionary or dot notation

Installation

PIP

$ pip install pluginlib

Fedora and EL (RHEL/CentOS/Rocky/Alma)

(EPEL repositories must be configured for EL8)

$ dnf install python3-pluginlib

EL7 (RHEL/CentOS)

(EPEL repositories must be configured)

$ yum install python2-pluginlib
$ yum install python36-pluginlib

Usage

Step 1: Define plugin parent classes

All plugins are subclasses of parent classes. To create a parent class, use the @Parent decorator.

The @Parent decorator can take a plugin type for accessing child plugins of the parent. If a plugin type isn’t given, the class name will be used.

The @Parent decorator can also take a group keyword which restricts plugins to a specific plugin group. group should be specified if plugins for different projects could be accessed in an single program, such as with libraries and frameworks. For more information, see the Plugin Groups section.

Methods required in child plugins should be labeled as abstract methods. Plugins without these methods or with parameters that don’t match, will not be loaded. For more information, see the Abstract Methods section.

"""
sample.py
"""
import pluginlib

@pluginlib.Parent('parser')
class Parser():

    @pluginlib.abstractmethod
    def parse(self, string):
        pass

Step 2: Define plugin classes

To create a plugin, subclass a parent class and include any required methods.

Plugins can be customized through optional class attributes:

_alias_

Changes the name of the plugin which defaults to the class name.

_version_

Sets the version of the plugin. Defaults to the module __version__ or None If multiple plugins with the same type and name are loaded, the plugin with the highest version is used. For more information, see the Versions section.

_skipload_

Specifies the plugin should not be loaded. This is useful when a plugin is a parent class for additional plugins or when a plugin should only be loaded under certain conditions. For more information see the Conditional Loading section.

"""
sample_plugins.py
"""
import json
import sample

class JSON(sample.Parser):

    _alias_ = 'json'

    def parse(self, string):
        return json.loads(string)

Step 3: Load plugins

Plugins are loaded when the module they are in is imported. PluginLoader will load modules from specified locations and provides access to them.

PluginLoader can load plugins from several locations.
  • A program’s standard library

  • Entry points

  • A list of modules

  • A list of filesystem paths

Plugins can also be filtered through blacklists and type filters. See the Blacklists and Type Filters sections for more information.

Plugins are accessible through the PluginLoader.plugins property, a nested dictionary accessible through dot notation. For other ways to access plugins, see the Accessing Plugins section.

import pluginlib
import sample

loader = pluginlib.PluginLoader(modules=['sample_plugins'])
plugins = loader.plugins
parser = plugins.parser.json()
print(parser.parse('{"json": "test"}'))

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pluginlib-0.10.0.tar.gz (45.9 kB view details)

Uploaded Source

Built Distribution

pluginlib-0.10.0-py2.py3-none-any.whl (24.7 kB view details)

Uploaded Python 2Python 3

File details

Details for the file pluginlib-0.10.0.tar.gz.

File metadata

  • Download URL: pluginlib-0.10.0.tar.gz
  • Upload date:
  • Size: 45.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.3

File hashes

Hashes for pluginlib-0.10.0.tar.gz
Algorithm Hash digest
SHA256 b442d2974fc4694e90e1a4a03bf9d6bdc6312c1f8c9d70802805919513618972
MD5 a8cb9488ac528b7748ab3470b54a2d5a
BLAKE2b-256 34c2596b7564d6a00d67320e5fcd2a8132deacf40d027bb1a307e1a210968470

See more details on using hashes here.

File details

Details for the file pluginlib-0.10.0-py2.py3-none-any.whl.

File metadata

  • Download URL: pluginlib-0.10.0-py2.py3-none-any.whl
  • Upload date:
  • Size: 24.7 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.3

File hashes

Hashes for pluginlib-0.10.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 ac9b80c76b7059c851153073f10128e1cf172131ca022597fc0f5f38b15a9b14
MD5 9c87080a31a82c3fb666aa2294c45371
BLAKE2b-256 3485ffdb94c6932d401f1a8ee0c9d1ec54e5b668451fd82857805a4e3361c97f

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page