helper.py

`ask_for_edit()` ¶

Asks the user for information edit.

Returns:

Type	Description
`bool`	User want to edit this field.

Source code in views/helper.py

def ask_for_edit():
    """Asks the user for information edit.

    Returns:
        bool: User want to edit this field.
    """

    confirm = typer.confirm("Modifier cette information?")

    return confirm

`ask_for_report_export()` ¶

Prompts the user to select export settings.

Returns:

Type	Description
`bool`	User wants to export the report.

Source code in views/helper.py

def ask_for_report_export():
    """Prompts the user to select export settings.

    Returns:
        bool: User wants to export the report.
    """

    print_info("souhaitez vous exporter ce rapport ?")

    number = typer.style("1. ", bold=True)
    typer.echo(number + "Oui")

    number = typer.style("2. ", bold=True)
    typer.echo(number + "Non")

    selection = ""

    while selection not in ["1", "2"]:
        selection = typer.prompt("Entrez votre sélection: ")

    if selection == "1":
        return True
    elif selection == "2":
        return False

`date_is_valid(date)` ¶

Verifies if the date entered by the user is valid using datetime library.

Returns:

Type	Description
`bool`	The date exists.

Source code in views/helper.py

def date_is_valid(date: str):
    """Verifies if the date entered by the user is valid using datetime library.

    Returns:
        bool: The date exists.
    """

    try:
        datetime.strptime(date, "%d/%m/%Y")
        return True
    except ValueError:
        if len(date) > 0:
            print_error("date incorrecte.")
        return False

`display_current_value(field_title, value)` ¶

Displays the current value of a field.

Parameters:

Name	Type	Description	Default
`field_title`	`str`	Title to display.	required
`value`	`Any`	Value to display.	required

Source code in views/helper.py

def display_current_value(field_title: str, value: Any):
    """Displays the current value of a field.

    Args:
        field_title (str): Title to display.
        value (Any): Value to display.
    """

    parameter = typer.style(f"\n{field_title}: ", bold=True)
    typer.echo(parameter + str(value))

`enter_new_value(field_title)` ¶

Displays a prompt for a new value.

Parameters:

Name	Type	Description	Default
`field_title`	`str`	Title to display.	required

Returns:

Type	Description
`str`	New value given by the user.

Source code in views/helper.py

def enter_new_value(field_title: str):
    """Displays a prompt for a new value.

    Args:
        field_title (str): Title to display.

    Returns:
        str: New value given by the user.
    """

    new_value = typer.prompt(f"Entrez une nouvelle valeur pour '{field_title}'")

    return new_value

`gender_is_valid(gender)` ¶

Verifies if the gender entered by the user is valid.

Returns:

Type	Description
`bool`	The gender is valid.

Source code in views/helper.py

def gender_is_valid(gender: str):
    """Verifies if the gender entered by the user is valid.

    Returns:
        bool: The gender is valid.
    """

    if len(gender) == 0:
        return False
    elif gender.lower() == "h":
        gender = "H"
        return True
    elif gender.lower() == "f":
        gender = "F"
        return True
    else:
        print_error("genre incorrect. Entrez H ou F.")
        return False

`go_back(current_view)` ¶

Go to previous menu based on current view.

Parameters:

Name	Type	Description	Default
`current_view`	`str`	Current view name based on class name.	required

Source code in views/helper.py

def go_back(current_view: str):
    """Go to previous menu based on current view.

    Args:
        current_view (str): Current view name based on class __name__.
    """

    if current_view in ["TournamentMenu", "PlayerMenu", "ReportMenu", "GameMenu"]:
        _MAIN_MENU.MainMenu()
    elif current_view in ["NewTournamentMenu", "LoadTournamentMenu", "EditTournamentMenu", "DeleteTournamentMenu"]:
        _TOURNAMENT_VIEWS.TournamentMenu()
    elif current_view in ["NewPlayerMenu", "EditPlayerMenu", "DeletePlayerMenu"]:
        _PLAYER_VIEWS.PlayerMenu()
    elif current_view in ["PlayerReportMenu", "TournamentReportMenu"]:
        _REPORT_VIEWS.ReportMenu()

`list_all_players()` ¶

Lists all existing players.

Source code in views/helper.py

def list_all_players():
    """Lists all existing players."""

    print_info("liste des joueurs existants:")

    all_players = DatabaseHandler().helper.get_players_by_id()

    for player in all_players:
        if player.is_deleted:
            continue

        player_id = typer.style(str(player.id_num), bold=True)
        typer.echo(f"{player_id}. {player.first_name} {player.last_name}")

`list_all_tournaments()` ¶

Lists all existing tournaments.

Source code in views/helper.py

def list_all_tournaments():
    """Lists all existing tournaments."""

    if DatabaseHandler().helper.is_tournament_db_empty():
        typer.secho("Aucun tournoi créé.", fg=typer.colors.RED)
        return

    print_info("liste des tournois existants:")

    all_tournaments = DatabaseHandler().helper.get_tournaments_by_id()

    for tournament in all_tournaments:
        if tournament.is_finished:
            is_finished = typer.style(" -> Terminé", fg=typer.colors.YELLOW)
        else:
            is_finished = ""
        typer.echo(f"{tournament.id_num}. {tournament.name} - {tournament.date}" + is_finished)

`modify_database_file()` ¶

Prompts the user to select a database file path.

Source code in views/helper.py

def modify_database_file():
    """Prompts the user to select a database file path."""

    _CONFIG.config["database_file"] = typer.prompt("Entrez un nouvel emplacement")

    if not _CONFIG.database_path_exists:
        print_error("L'emplacement saisi est incorrect. Vérifiez que le dossier existe.")
        modify_database_file()
    elif not _CONFIG.database_is_json():
        print_error("Votre fichier doit avoir comme extension '.json'.")
        modify_database_file()
    elif not _CONFIG.database_exists:
        print_error("Le fichier de base de données n'existe pas encore, un nouveau sera donc créé.")
    else:
        print_success("Un fichier de base de données existant a été trouvé.")

`modify_report_save_path()` ¶

Prompts the user to select a report save path.

Source code in views/helper.py

def modify_report_save_path():
    """Prompts the user to select a report save path."""

    _CONFIG.config["report_save_path"] = typer.prompt("Entrez un nouvel emplacement")

    if not _CONFIG.report_save_path_exists():
        print_error("L'emplacement saisi est incorrect. Vérifiez que le dossier existe.")
        modify_report_save_path()

`player_exists(selected_id, already_taken_ids=[])` ¶

Verifies if the player selected by the user exists.

Parameters:

Name	Type	Description	Default
`selected_id`	`str`	Player chosen by the user.	required
`already_taken_ids`	`list`	List of ids the user cannot choose from. Defaults to [].	`[]`

Returns:

Type	Description
`bool`	The user is selectable.

Source code in views/helper.py

def player_exists(selected_id: str, already_taken_ids: list = []):
    """Verifies if the player selected by the user exists.

    Args:
        selected_id (str): Player chosen by the user.
        already_taken_ids (list, optional): List of ids the user cannot choose from. Defaults to [].

    Returns:
        bool: The user is selectable.
    """

    if len(selected_id) == 0:
        return False

    if not selected_id.isnumeric():
        print_error("entrez le numéro du joueur apparaissant devant son nom")
        return False

    if int(selected_id) in already_taken_ids:
        print_error(f"le joueur numéro {selected_id} a déjà été ajouté")
        return False

    if DatabaseHandler().helper.is_player_id_in_database(player_id=int(selected_id)):
        if DatabaseHandler().helper.get_player_object_from_id_str(player_id=selected_id).is_deleted:
            return False
        return True

    print_error(f"pas de joueur avec le numéro {selected_id}")

    return False

`print_error(message)` ¶

Prints a formated error message.

Parameters:

Name	Type	Description	Default
`message`	`str`	Message content.	required

Source code in views/helper.py

def print_error(message: str):
    """Prints a formated error message.

    Args:
        message (str): Message content.
    """

    typer.secho(f"! {message.capitalize()}", fg=typer.colors.BRIGHT_RED, bg=typer.colors.BRIGHT_BLACK, bold=True)
    typer.echo("\n")

`print_info(message)` ¶

Prints a formated info message.

Parameters:

Name	Type	Description	Default
`message`	`str`	Message content.	required

Source code in views/helper.py

def print_info(message: str):
    """Prints a formated info message.

    Args:
        message (str): Message content.
    """

    typer.secho(f"- {message.capitalize()}", fg=typer.colors.BRIGHT_MAGENTA, bg=typer.colors.BRIGHT_BLACK, bold=True)
    typer.echo("\n")

`print_report(data)` ¶

Prints a generated report in console.

Parameters:

Name	Type	Description	Default
`data`	`dict`	Report data dict.	required

Source code in views/helper.py

def print_report(data: dict):
    """Prints a generated report in console.

    Args:
        data (dict): Report data dict.
    """

    for element in data:
        for key in element:
            field_name = key + ": "
            value = typer.style(str(element[key]), bold=True)
            typer.echo(field_name + value)
        typer.echo("\n")

`print_success(message)` ¶

Prints a formated success message.

Parameters:

Name	Type	Description	Default
`message`	`str`	Message content.	required

Source code in views/helper.py

def print_success(message: str):
    """Prints a formated success message.

    Args:
        message (str): Message content.
    """

    typer.secho(f"> {message.capitalize()}", fg=typer.colors.BRIGHT_GREEN, bg=typer.colors.BRIGHT_BLACK, bold=True)
    typer.echo("\n")

`print_title(message)` ¶

Prints a formated title.

Parameters:

Name	Type	Description	Default
`message`	`str`	Message content.	required

Source code in views/helper.py

def print_title(message: str):
    """Prints a formated title.

    Args:
        message (str): Message content.
    """

    typer.secho(f"- {message.upper()} -", fg=typer.colors.BRIGHT_CYAN, bg=typer.colors.BRIGHT_BLACK, bold=True)
    typer.echo("\n")

`print_warning(message)` ¶

Prints a formated warning message.

Parameters:

Name	Type	Description	Default
`message`	`str`	Message content.	required

Source code in views/helper.py

def print_warning(message: str):
    """Prints a formated warning message.

    Args:
        message (str): Message content.
    """

    typer.secho(f"{message.upper()}", fg=typer.colors.RED, blink=True, bold=True)
    typer.echo("\n")

`print_welcome_splash()` ¶

Prints ASCII presentation.

Source code in views/helper.py

def print_welcome_splash():
    """Prints ASCII presentation."""

    welcome_splash_lines = [
        ["    __", ""],
        ["   /  \\", "                      _                         _       _"],
        ["   \\__/", "                     | |                       | |     | |"],
        ["  /____\\", "     ___   ___   ___| |__   ___  ___ ___   ___| |_   _| |__"],
        ["   |  |", "     / _ \\ / __| / __| '_ \\ / _ \\/ __/ __| / __| | | | | '_ \\"],
        ["   |__|", "    | (_) | (__ | (__| | | |  __/\\__ \\__ \\| (__| | |_| | |_) |"],
        ["  (====)", "    \\___/ \\___| \\___|_| |_|\\___||___/___/ \\___|_|\\__,_|_.__/"],
        ["  }===={", "            ______                    ______ "],
        [" (______)", "          |______|                  |______|"],
    ]

    for pawn, title in welcome_splash_lines:
        pawn_part = typer.style(pawn, fg=typer.colors.BRIGHT_WHITE, bold=True)
        title_part = typer.style(title, fg=typer.colors.BRIGHT_MAGENTA)

        typer.echo(pawn_part + title_part)

    typer.echo("\n")

`prompt_config_modification()` ¶

Prompts the user to change the configuration.

Source code in views/helper.py

def prompt_config_modification():
    """Prompts the user to change the configuration."""

    confirm = typer.confirm("Souhaitez vous modifier la configuration actuelle ?")

    if not confirm:
        recheck_config()
        return

    typer.secho(f'Base de données actuelle: {_CONFIG.config["database_file"]}', bold=True)
    confirm = typer.confirm("Modifier ?")
    if confirm:
        modify_database_file()

    typer.secho(f'Emplacement de sauvegarde des rapports actuel: {_CONFIG.config["report_save_path"]}', bold=True)
    confirm = typer.confirm("Modifier ?")
    if confirm:
        modify_report_save_path()

    _CONFIG.save_settings()
    recheck_config()

`recheck_config()` ¶

Checks the configuration validity and prints adequate error messages.

Source code in views/helper.py

def recheck_config():
    """Checks the configuration validity and prints adequate error messages."""

    database_path_dont_exists = not _CONFIG.database_path_exists()
    database_dont_exists = not _CONFIG.database_exists()
    report_save_path_dont_exists = not _CONFIG.report_save_path_exists()

    if not any([database_path_dont_exists, database_dont_exists, report_save_path_dont_exists]):
        print_success("La configuration ne comporte aucune erreur.")
        return

    print_warning("Votre configuration comporte toujours les erreurs suivantes:")
    if database_path_dont_exists:
        print_error("L'emplacement de la base de données est invalide.")
    if database_dont_exists:
        print_error("Le fichier de base de données n'existe pas. Il sera donc créé.")
    if report_save_path_dont_exists:
        print_error("L'emplacement de sauvegarde des rapports est invalide.")

`report_export_prompt()` ¶

Prompts the user to export the generated report.

Returns:

Type	Description
`str`	Selected export format.

Source code in views/helper.py

def report_export_prompt():
    """Prompts the user to export the generated report.

    Returns:
        str: Selected export format.
    """

    if not ask_for_report_export():
        return None

    return select_export_format()

`select_export_format()` ¶

Prompts the user to select export format.

Returns:

Type	Description
`str`	Selected export format.

Source code in views/helper.py

def select_export_format():
    """Prompts the user to select export format.

    Returns:
        str: Selected export format.
    """

    print_info("choisissez un format d'export:")

    number = typer.style("1. ", bold=True)
    typer.echo(number + "Texte")

    number = typer.style("2. ", bold=True)
    typer.echo(number + "CSV")

    number = typer.style("\n0. ", bold=True)
    typer.echo(number + "Retour")

    selection = ""

    while selection not in ["1", "2", "0"]:
        selection = typer.prompt("Entrez votre sélection: ")

    if selection == "0":
        return None
    if selection == "1":
        return "txt"
    elif selection == "2":
        return "csv"

`select_player()` ¶

Prompts the user to select a player in database.

Source code in views/helper.py

def select_player():
    """Prompts the user to select a player in database."""

    if DatabaseHandler().helper.is_player_db_empty():
        return None

    list_all_players()

    selection = ""
    while not player_exists(selected_id=selection):
        selection = typer.prompt("Sélectionnez un joueur")

    return DatabaseHandler().helper.get_player_object_from_id_str(player_id=selection)

`select_tournament()` ¶

Prompts the user to select a tournament in database.

Source code in views/helper.py

def select_tournament():
    """Prompts the user to select a tournament in database."""

    if DatabaseHandler().helper.is_tournament_db_empty():
        return None

    list_all_tournaments()

    selection = ""
    while not tournament_exists(selected_id=selection):
        selection = typer.prompt("Sélectionnez un tournoi")

    return DatabaseHandler().helper.get_tournament_object_from_id_str(tournament_id=selection)

`tournament_exists(selected_id)` ¶

Verifies if the tournament selected by the user exists.

Parameters:

Name	Type	Description	Default
`selected_id`	`str`	Tournament chosen by the user.	required

Returns:

Type	Description
`bool`	The tournament is selectable.

Source code in views/helper.py

def tournament_exists(selected_id: str):
    """Verifies if the tournament selected by the user exists.

    Args:
        selected_id (str): Tournament chosen by the user.

    Returns:
        bool: The tournament is selectable.
    """

    if len(selected_id) == 0:
        return False

    if not selected_id.isnumeric():
        print_error("entrez le numéro du tournoi apparaissant devant son nom")
        return False

    if DatabaseHandler().helper.is_tournament_id_in_database(tournament_id=int(selected_id)):
        return True

    print_error(f"pas de tournoi avec le numéro {selected_id}")

    return False

helper.py

ask_for_edit() ¶

ask_for_report_export() ¶

date_is_valid(date) ¶

display_current_value(field_title, value) ¶

enter_new_value(field_title) ¶

gender_is_valid(gender) ¶

go_back(current_view) ¶

list_all_players() ¶

list_all_tournaments() ¶

modify_database_file() ¶

modify_report_save_path() ¶

player_exists(selected_id, already_taken_ids=[]) ¶

print_error(message) ¶

print_info(message) ¶

print_report(data) ¶

print_success(message) ¶

print_title(message) ¶

print_warning(message) ¶

print_welcome_splash() ¶

prompt_config_modification() ¶

recheck_config() ¶

report_export_prompt() ¶

select_export_format() ¶

select_player() ¶

select_tournament() ¶

tournament_exists(selected_id) ¶

`ask_for_edit()` ¶

`ask_for_report_export()` ¶

`date_is_valid(date)` ¶

`display_current_value(field_title, value)` ¶

`enter_new_value(field_title)` ¶

`gender_is_valid(gender)` ¶

`go_back(current_view)` ¶

`list_all_players()` ¶

`list_all_tournaments()` ¶

`modify_database_file()` ¶

`modify_report_save_path()` ¶

`player_exists(selected_id, already_taken_ids=[])` ¶

`print_error(message)` ¶

`print_info(message)` ¶

`print_report(data)` ¶

`print_success(message)` ¶

`print_title(message)` ¶

`print_warning(message)` ¶

`print_welcome_splash()` ¶

`prompt_config_modification()` ¶

`recheck_config()` ¶

`report_export_prompt()` ¶

`select_export_format()` ¶

`select_player()` ¶

`select_tournament()` ¶

`tournament_exists(selected_id)` ¶