parsing_params.py

from my_types import Indices, Params

YEAR_WITH_NO_VR_VOTE = 2018
YEAR_WITH_DECADE_VOTE = 2019
DIGIT_OF_LAST_YEAR_OF_DECADE = YEAR_WITH_DECADE_VOTE % 10
YEAR_WITH_MORE_CHOICES_FOR_GOTY = 2024


def get_main_categories() -> list[str]:
    # Caveat: the order matters!
    return ["goty", "gotd"]


def get_optional_categories() -> list[str]:
    # Caveat: the order matters!
    return ["dlc", "early_access", "vr", "turd"]


def get_categories(categorie_type: str = "main") -> list[str]:
    if categorie_type == "main":
        categories = get_main_categories()
    else:
        categories = get_optional_categories()

    return categories


def get_default_parsing_params() -> Params:
    params = {}

    for categorie in get_main_categories():
        params[categorie] = {"num_choices": 5}

    for categorie in get_optional_categories():
        params[categorie] = {"num_choices": 1}

    return params


def adjust_params_to_year(
    params: Params,
    year: str,
) -> Params:
    # NB: in 2018, there was no vote for the best VR game. In 2019 and subsequent years, there was one.
    if int(year) == YEAR_WITH_NO_VR_VOTE:
        params["vr"]["num_choices"] = 0

    # NB: if the ballot year ends with a "9", e.g. "2019", then it is the last year of its decade, and there is a GotD.
    if int(year) % 10 == DIGIT_OF_LAST_YEAR_OF_DECADE:
        params["gotd"]["num_choices"] = 10
    else:
        params["gotd"]["num_choices"] = 0

    # NB: in 2024, there are 10 choices (instead of 5) for the GotY.
    if int(year) == YEAR_WITH_MORE_CHOICES_FOR_GOTY:
        params["goty"]["num_choices"] = 10

    return params


def get_adjusted_parsing_params(year: str) -> Params:
    return adjust_params_to_year(get_default_parsing_params(), year)


def get_next_indices(
    last_index: int = 0,
    num_indices: int = 0,
) -> tuple[int, int, int | None]:
    # The first index to include
    start = 1 + last_index

    # The first index NOT to include
    end = num_indices + start

    description_index = end if num_indices > 0 else None

    return start, end, description_index


def convert_params_to_indices(
    params: Params,
    offset: int = 9,
) -> Indices:
    voter_index = offset

    indices: Indices = {
        "voter_name": {"index": [voter_index]},
        "main": {},
        "review": {},
        "optional": {},
    }

    last_index = voter_index

    for categorie in get_categories("main"):
        start, end, descr = get_next_indices(
            last_index=last_index,
            num_indices=params[categorie]["num_choices"],
        )
        indices["main"][categorie] = list(range(start, end))
        indices["review"][categorie] = [descr]

        if descr is not None:
            # range() will stop at end-1, and then the review is at index equal to end, so the last index is "end"
            last_index = end

    for categorie in get_categories("optional"):
        start, end, descr = get_next_indices(
            last_index=last_index,
            num_indices=params[categorie]["num_choices"],
        )
        indices["optional"][categorie] = list(range(start, end))

        # range() will stop at end-1, and then there is NO review for optional categories, so the last index is "end-1"
        last_index = end - 1

    return indices


def get_parsing_offset(*, is_anonymized: bool) -> int:
    return 0 if is_anonymized else 9


def get_parsing_indices(
    year: str,
    *,
    is_anonymized: bool,
) -> Indices:
    params = get_adjusted_parsing_params(year=year)
    offset = get_parsing_offset(is_anonymized=is_anonymized)
    return convert_params_to_indices(params, offset)


if __name__ == "__main__":
    ballot_year = "2018"

    params = get_adjusted_parsing_params(year=ballot_year)
    print(params)

    indices = get_parsing_indices(year=ballot_year, is_anonymized=False)
    print(indices)

    indices = get_parsing_indices(year=ballot_year, is_anonymized=True)
    print(indices)