Source code for thoth.adviser.sieves.experimental_prereleases

#!/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
# 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 <>.

"""A sieve to filter out pre-releases, selectively."""

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

import attr
from thoth.common import get_justification_link as jl
from thoth.python import PackageVersion
from voluptuous import Schema
from voluptuous import Required

from ..sieve import Sieve

    from ..pipeline_builder import PipelineBuilderContext

_LOGGER = logging.getLogger(__name__)

[docs]@attr.s(slots=True) class SelectiveCutPreReleasesSieve(Sieve): """Enable or disable specific pre-releases for the given set of packages..""" CONFIGURATION_DEFAULT = {"package_name": None, "allow_prereleases": None} CONFIGURATION_SCHEMA: Schema = Schema( {Required("package_name"): None, Required("allow_prereleases"): Schema({str: bool})} ) _JUSTIFICATION_LINK = jl("selective_prereleases") packages_seen = attr.ib(type=Set[Tuple[str, str, str]], default=attr.Factory(set), init=False)
[docs] @classmethod def should_include(cls, builder_context: "PipelineBuilderContext") -> Generator[Dict[str, Any], None, None]: """Enable or disable specific pre-releases for the given set of packages..""" if builder_context.project.prereleases_allowed: if builder_context.project.prereleases_allowed: msg = "Ignoring selective pre-releases in [thoth] section as global allow_prereleases flag is set" _LOGGER.warning(msg) yield from () return None if ( builder_context.is_included(cls) or not builder_context.project.pipfile.thoth or not builder_context.project.pipfile.thoth.allow_prereleases ): yield from () return None yield { "package_name": None, "allow_prereleases": builder_context.project.pipfile.thoth.allow_prereleases, }
[docs] def pre_run(self) -> None: """Initialize this pipeline unit before each run.""" self.packages_seen.clear() super().pre_run()
[docs] def run(self, package_versions: Generator[PackageVersion, None, None]) -> Generator[PackageVersion, None, None]: """Cut-off pre-releases if project does not explicitly allows them.""" for package_version in package_versions: if ( not self.configuration["allow_prereleases"].get(, False) and package_version.semantic_version.is_prerelease ): package_tuple = package_version.to_tuple() if package_tuple not in self.packages_seen: self.packages_seen.add(package_tuple) msg = f"Removing package {package_tuple} as pre-releases are disabled" _LOGGER.warning("%s - see %s", msg, self._JUSTIFICATION_LINK) self.context.stack_info.append( { "message": msg, "type": "WARNING", "link": self._JUSTIFICATION_LINK, } ) continue yield package_version