httpie-cli/httpie/plugins/manager.py

79 lines
2.4 KiB
Python
Raw Normal View History

from itertools import groupby
2019-09-01 11:45:47 +02:00
from operator import attrgetter
2019-09-01 11:13:45 +02:00
from typing import Dict, List, Type
2019-08-31 18:33:54 +02:00
2013-09-21 23:46:15 +02:00
from pkg_resources import iter_entry_points
2019-09-01 11:13:45 +02:00
from ..utils import repr_dict
from . import AuthPlugin, ConverterPlugin, FormatterPlugin
from .base import BasePlugin, TransportPlugin
2013-09-21 23:46:15 +02:00
ENTRY_POINT_NAMES = [
'httpie.plugins.auth.v1',
'httpie.plugins.formatter.v1',
'httpie.plugins.converter.v1',
'httpie.plugins.transport.v1',
2013-09-21 23:46:15 +02:00
]
2019-09-01 11:13:45 +02:00
class PluginManager(list):
2013-09-21 23:46:15 +02:00
2019-08-31 18:33:54 +02:00
def register(self, *plugins: Type[BasePlugin]):
for plugin in plugins:
2019-09-01 11:13:45 +02:00
self.append(plugin)
2013-09-21 23:46:15 +02:00
2019-08-31 18:35:24 +02:00
def unregister(self, plugin: Type[BasePlugin]):
2019-09-01 11:13:45 +02:00
self.remove(plugin)
def filter(self, by_type=Type[BasePlugin]):
return [plugin for plugin in self if issubclass(plugin, by_type)]
def load_installed_plugins(self):
for entry_point_name in ENTRY_POINT_NAMES:
for entry_point in iter_entry_points(entry_point_name):
plugin = entry_point.load()
plugin.package_name = entry_point.dist.key
self.register(entry_point.load())
# Auth
2019-08-31 18:33:54 +02:00
def get_auth_plugins(self) -> List[Type[AuthPlugin]]:
2019-09-01 11:13:45 +02:00
return self.filter(AuthPlugin)
2013-09-21 23:46:15 +02:00
2019-08-31 18:33:54 +02:00
def get_auth_plugin_mapping(self) -> Dict[str, Type[AuthPlugin]]:
return {
plugin.auth_type: plugin for plugin in self.get_auth_plugins()
}
2013-09-21 23:46:15 +02:00
2019-08-31 18:33:54 +02:00
def get_auth_plugin(self, auth_type: str) -> Type[AuthPlugin]:
2013-09-21 23:46:15 +02:00
return self.get_auth_plugin_mapping()[auth_type]
# Output processing
2019-08-31 18:33:54 +02:00
def get_formatters(self) -> List[Type[FormatterPlugin]]:
2019-09-01 11:13:45 +02:00
return self.filter(FormatterPlugin)
2019-08-31 18:33:54 +02:00
def get_formatters_grouped(self) -> Dict[str, List[Type[FormatterPlugin]]]:
2019-09-01 11:45:47 +02:00
return {
group_name: list(group)
for group_name, group
in groupby(self.get_formatters(), key=attrgetter('group_name'))
}
2019-08-31 18:33:54 +02:00
def get_converters(self) -> List[Type[ConverterPlugin]]:
2019-09-01 11:13:45 +02:00
return self.filter(ConverterPlugin)
# Adapters
2019-08-31 18:33:54 +02:00
def get_transport_plugins(self) -> List[Type[TransportPlugin]]:
2019-09-01 11:13:45 +02:00
return self.filter(TransportPlugin)
def __str__(self):
return repr_dict({
'adapters': self.get_transport_plugins(),
'auth': self.get_auth_plugins(),
'converters': self.get_converters(),
'formatters': self.get_formatters(),
})
2019-09-01 11:13:45 +02:00
def __repr__(self):
return f'<{type(self).__name__} {self}>'