Source code for thoth.adviser.boots.prescription_release

#!/usr/bin/env python3
# thoth-adviser
# Copyright(C) 2021 Fridolin Pokorny
#
# 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 3 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, see <http://www.gnu.org/licenses/>.

"""A boot that adds info about prescription release."""

import logging
from typing import Any
from typing import Dict
from typing import Generator
from typing import TYPE_CHECKING

import attr

from thoth.common import get_justification_link as jl

from ..boot import Boot

if TYPE_CHECKING:
    from ..pipeline_builder import PipelineBuilderContext

_LOGGER = logging.getLogger(__name__)


[docs]@attr.s(slots=True)
class PrescriptionReleaseBoot(Boot):
    """Add information about prescription release used."""

    _JUSTIFICATION_LINK = jl("prescription")

[docs]    @classmethod
    def should_include(cls, builder_context: "PipelineBuilderContext") -> Generator[Dict[str, Any], None, None]:
        """Register self if a prescription is used."""
        if builder_context.prescription is not None and not builder_context.is_included(cls):
            yield {}
            return None

        yield from ()
        return None

[docs]    def run(self) -> None:
        """Add information about prescription release used."""
        if self.context.prescription is None:
            return

        for prescription in self.context.prescription.prescriptions:
            message = f"Using prescriptions {prescription[0]!r} release {prescription[1]!r}"
            _LOGGER.info("%s - see %s", message, self._JUSTIFICATION_LINK)
            self.context.stack_info.append({"type": "INFO", "message": message, "link": self._JUSTIFICATION_LINK})