A plugin manager based on setuptools entry points mechanism
Project description
Reentry
A plugin manager based on setuptools entry points with 10x the speed
What for?
To make entry points usable for plugins in time-critical situations (like commandline interfaces)!
Setuptool’s entry point system is convenient to use for plugin based python applications. It allows separate python packaes to act as plugins to a host package, making it easy for the host to find and iterate over the relevant data structures from plugins.
However simply importing setuptools scales badly with the number of installed distributions and can be very slow for moderately complex environments (~ 0.5 s). Finding and loading of plugins on the other hand is time-critical in cases like commandline tools loading subcommands, where 100 ms are a noticeable delay.
Setuptools’s pkg_resources is slow, because it verifies dependencies are installed correctly for all distributions present in the environment on import. This allows entry points to have additional requirements.
Reentry forgoes this dependency check for entry points without such ‘extras’ dependencies and thereby manages to be fast and scale better, with the amount of installed plugins, not installed python packages in general.
Standalone Manager Usage
Sometimes it might be necessary to update the cached entry points, for example
after uninstalling a plugin (there are no uninstall hooks by setuptools atm)
after installing a plugin that does not use install hooks
while developping a plugin / plugin host
for those cases reentry has a commandline interface:
$ reentry --help Usage: reentry [OPTIONS] COMMAND [ARGS]... manage your reentry python entry point cache Options: --help Show this message and exit. Commands: map scan Scan for python entry points to cache for...
$ reentry scan --help Usage: reentry scan [OPTIONS] PATTERN Scan for python entry points to cache for faster loading. Scan only for specific PATTERNs or leave empty to scan all Options: -r, --regex Treat PATTERNs as regular expresions --help Show this message and exit.
$ reentry map --help Usage: reentry map [OPTIONS] Options: --dist TEXT limit map to a distribution --group TEXT limit map to an entry point group --name TEXT limit map to entrypoints that match NAME --help Show this message and exit.
CLI Example
Reentry provides a drop-in replacement for iter_entry_points:
import click
from click_plugins import with_plugins
from reentry.manager import iter_entry_points
@with_plugins(iter_entry_points('cli_plugins'))
@click.group()
def cli():
"""
command with subcommands loaded from plugin entry points
"""
For this to work, reentry has to be installed and must have been used to scan for entry points in the ‘cli_plugins’ group once.
Features
finding plugins: reentry keeps a map of entry points in a file
speed: reentry provides an EntryPoint implementation that trades extras for search and load speed
automatic registering: reentry provides setup() keyword args to register and scan for entry points on install
flexible: entry points with extras dependencies still work trying to load them will lead to loading pkg_resources
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file reentry-1.0.3.tar.gz.
File metadata
- Download URL: reentry-1.0.3.tar.gz
- Upload date:
- Size: 10.5 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 6edae349403b156641b70ef63cb6aacb17bf6ce0a00ef9a31eb27da2701b9d1d |
|
| MD5 | 9308b09e98232eaaa16d62a02b961bec |
|
| BLAKE2b-256 | ea996c6537ad650a89f1bd8d9459f1d97dc63d935b1daf6bbe5c2b0237a2c6fb |
File details
Details for the file reentry-1.0.3-py2.py3-none-any.whl.
File metadata
- Download URL: reentry-1.0.3-py2.py3-none-any.whl
- Upload date:
- Size: 16.5 kB
- Tags: Python 2, Python 3
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 5efd0597fb07a3e56c77a4b5c40ca58aa4d7dacdde67ab081976c9296941642b |
|
| MD5 | 6aaea8c40c2d72841dc2e304573b5b2f |
|
| BLAKE2b-256 | a1d67e40f252f03bab365893de973215c6c50481ad9aad7780ad73b83424d614 |
