Source code for rebasehelper.plugins.versioneers

# -*- 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>

import logging
from typing import cast

from rebasehelper.logger import CustomLogger
from rebasehelper.plugins.plugin import Plugin
from rebasehelper.plugins.plugin_collection import PluginCollection
from rebasehelper.types import PackageCategories


logger: CustomLogger = cast(CustomLogger, logging.getLogger(__name__))


[docs]class BaseVersioneer(Plugin): """Base class for a versioneer""" CATEGORIES: PackageCategories = []
[docs] @classmethod def run(cls, package_name): """ Runs a versioneer. :param package_name: Name of a package :return: Latest upstream version of a package """ raise NotImplementedError()
[docs]class VersioneerCollection(PluginCollection):
[docs] def run(self, versioneer, package_name, category, versioneer_blacklist=None): """Runs the specified versioneer or all versioneers subsequently until one of them succeeds. Args: versioneer (str): Name of a versioneer. package_name (str): Name of a package. category (str): Package category. versioneer_blacklist (list): List of versioneers that will be skipped. Returns: str: Latest upstream version of a package. """ if versioneer_blacklist is None: versioneer_blacklist = [] if versioneer: logger.info("Running '%s' versioneer", versioneer) return self.plugins[versioneer].run(package_name) # run all versioneers, except those disabled in config, categorized first allowed_versioneers = [v for k, v in self.plugins.items() if v and k not in versioneer_blacklist] for versioneer in sorted(allowed_versioneers, key=lambda v: not v.CATEGORIES): categories = versioneer.CATEGORIES if not categories or category in categories: logger.info("Running '%s' versioneer", versioneer.name) result = versioneer.run(package_name) if result: return result return None