Source code for sr.comp.teams

"""Team metadata library."""

from __future__ import annotations

from pathlib import Path
from typing import NamedTuple

from . import yaml_loader
from .types import MatchNumber, TLA


class Team(NamedTuple):
    tla: TLA
    name: str
    rookie: bool
    dropped_out_after: MatchNumber | None

    def is_still_around(self, match_number: MatchNumber) -> bool:
        """
        Check if this team is still around at a certain match.

        :param int match_number: The number of the match to check.
        :returns: ``True`` if the team is still playing.
        """

        if self.dropped_out_after is None:
            return True
        else:
            return match_number <= self.dropped_out_after


def load_teams(filename: Path) -> dict[TLA, Team]:
    """
    Load teams from a YAML file.

    :param Path filename: The filename of the YAML file to load.
    :return: A dictionary mapping TLAs to :class:`Team` objects.
    """

    data = yaml_loader.load(filename)

    teams = {}
    for tla, info in data['teams'].items():
        tla = tla.upper()
        teams[tla] = Team(
            tla=tla,
            name=info['name'],
            rookie=info.get('rookie', False),
            dropped_out_after=info.get('dropped_out_after'),
        )

    return teams