Source code for rebasehelper.plugins.plugin_collection

# -*- coding: utf-8 -*-
#
# This tool helps you rebase your package to the latest version
# Copyright (C) 2013-2019 Red Hat, Inc.
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License along
# with this program; if not, write to the Free Software Foundation, Inc.,
# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
#
# Authors: Petr Hráček <phracek@redhat.com>
#          Tomáš Hozza <thozza@redhat.com>
#          Nikola Forró <nforro@redhat.com>
#          František Nečas <fifinecas@seznam.cz>

from typing import Dict, List, Optional, Type, Union, TYPE_CHECKING

from rebasehelper.plugins.plugin_loader import PluginLoader
from rebasehelper.plugins.plugin import Plugin
from rebasehelper.types import Options

if TYPE_CHECKING:
    # avoid cyclic import at runtime
    from rebasehelper.plugins.plugin_manager import PluginManager


[docs]class PluginCollection: def __init__(self, entrypoint: str, manager: 'PluginManager'): self.plugins: Dict[str, Optional[Type[Plugin]]] = PluginLoader.load(entrypoint, manager)
[docs] def get_all_plugins(self) -> List[str]: return list(self.plugins)
[docs] def get_supported_plugins(self) -> List[str]: return [k for k, v in self.plugins.items() if v]
[docs] def get_default_plugins(self, return_one: bool = False) -> Union[str, List[str], None]: default = [k for k, v in self.plugins.items() if v and getattr(v, 'DEFAULT', False)] return default if not return_one else default[0] if default else None
[docs] def get_plugin(self, tool: str) -> Optional[Type[Plugin]]: try: return self.plugins[tool] except KeyError as e: raise NotImplementedError("Unsupported plugin") from e
[docs] def get_options(self) -> Options: """Gets options of all plugins of one type. Returns: list: List of plugins' options. """ options: List = [] for plugin in self.plugins.values(): if plugin: options.extend(plugin.OPTIONS) return options