Skip to content

Login

Handles the backend for the login process.

login(first_name, last_name, attributes)

Login entry point.

Parameters:

Name Type Description Default
first_name str

First name entered by the user.

 required
last_name str

Last name entered by the user.

 required
attributes AppAttributes

The current app attributes.

 required

Returns:

Type Description
(str, AppState | None)

A string containing the user hash on success or an error message on errror and the current app state on success or None on error.
Source code in evaluator/backend/login.py 
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
def login(
    first_name: str, last_name: str, attributes: AppAttributes
) -> tuple[str, Optional[AppState]]:
    """Login entry point.

    Parameters
    ----------
    first_name : str
        First name entered by the user.
    last_name : str
        Last name entered by the user.
    attributes : AppAttributes
        The current app attributes.

    Returns
    -------
    (str, AppState | None)
        A string containing the user hash on success or an
        error message on errror and the current app state
        on success or None on error.
    """
    if not first_name and not last_name:
        return "Error: First and last name are required.", None
    elif not first_name:
        return "Error: First name is required.", None
    elif not last_name:
        return "Error: Last name is required.", None

    first_name = first_name.strip().lower()
    last_name = last_name.strip().lower()

    user_hash = _generate_user_hash(first_name, last_name)

    if _check_user_existence(user_hash, attributes):
        attributes["logger"].info(f"Found existing user for {last_name}, {first_name}")
        new_user = False
    else:
        new_user = True

    app_state = create_app_state(
        attributes=attributes, user_hash=user_hash, new_user=new_user
    )
    if new_user:
        app_state = create_new_user(
            app_state=app_state, first_name=first_name, last_name=last_name
        )

    log_state(app_state, "app")

    return user_hash, app_state

_check_user_existence(user_hash, attributes)

Checks if the user already exists or not.

user_hash : str The user's md5 hash. attributes : AppAttributes The current app state.

Returns:

Type Description
bool

True if the user exists, False otherwise.
Source code in evaluator/backend/login.py 
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
def _check_user_existence(user_hash: str, attributes: AppAttributes) -> bool:
    """Checks if the user already exists or not.

    user_hash : str
        The user's md5 hash.
    attributes : AppAttributes
        The current app state.

    Returns
    -------
    bool
        True if the user exists, False otherwise.
    """
    if user_hash in attributes["users_data"]:
        return True
    else:
        return False

_generate_user_hash(first_name, last_name)

Generates the user's MD5 hash.

Parameters:

Name Type Description Default
first_name str

The user's first name.

 required
last_name str

The user's last name.

 required

Returns:

Type Description
str

The user hash.
Source code in evaluator/backend/login.py 
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
def _generate_user_hash(first_name: str, last_name: str) -> str:
    """Generates the user's MD5 hash.

    Parameters
    ----------
    first_name : str
        The user's first name.
    last_name : str
        The user's last name.

    Returns
    -------
    str
        The user hash.
    """
    name_list = [first_name, last_name]
    sorted(name_list)
    name_str = "_".join(name_list)
    hash_hex = md5(name_str.encode("utf-8")).hexdigest()
    return hash_hex