version_pr_info.py

from typing import Literal

from pydantic import TypeAdapter, model_validator

from conda_forge_tick.models.common import NoneIsEmptyDict, StrictBaseModel


class VersionPrInfo(StrictBaseModel):
    bad: str | Literal[False] = False
    """
    If this value is non-False, the string indicates the error.
    """

    new_version: str | Literal[False] = False
    """
    The latest version found by update_upstream_versions, which is copied from `versions` in the beginning of the
    auto_tick run.
    """

    new_version_attempts: NoneIsEmptyDict[str, int | float] = {}
    """
    Mapping (version -> number of attempts) to describe the number of attempts that were made to update the versions in
    the PR. The value can be a float since failing with a solving error is counted as a partial attempt, which only
    increases the count by a fraction that is specified in auto_tick.run (03/2024: 0.2).
    """

    new_version_errors: NoneIsEmptyDict[str, str] = {}
    """
    Mapping (version -> error message) to describe the errors that occurred when trying to update the versions in the
    PR.
    """

    @model_validator(mode="after")
    def check_new_version_error_keys(self):
        wrong_versions = [
            version
            for version in self.new_version_errors
            if version not in self.new_version_attempts
        ]

        if wrong_versions:
            raise ValueError(
                f"new_version_errors contains at least one version not in new_version_attempts: {wrong_versions}"
            )


VersionPrInfo = TypeAdapter(VersionPrInfo)