Function login

scratchattach/site/session.py:1400–1442

Creates a session / log in to the Scratch website with the specified username and password. This method ... 1. creates a session id by posting a login request to Scratch's login API. (If this fails, scratchattach.exceptions.LoginFailure is raised) 2. fetches the xtoken and other in

(username, password, *, timeout=10)

def login(username, password, *, timeout=10) -> Session:
    """
    Creates a session / log in to the Scratch website with the specified username and password.

    This method ...
    1. creates a session id by posting a login request to Scratch's login API. (If this fails, scratchattach.exceptions.LoginFailure is raised)
    2. fetches the xtoken and other information by posting a request to scratch.mit.edu/session. (If this fails, a warning is displayed)

    Args:
        username (str)
        password (str)

    Keyword arguments:
        timeout (int): Timeout for the request to Scratch's login API (in seconds). Defaults to 10.

    Returns:
        scratchattach.session.Session: An object that represents the created login / session
    """
    issue_login_warning()

    # Post request to login API:
    _headers = headers.copy()
    _headers["Cookie"] = "scratchcsrftoken=a;scratchlanguage=en;"
    with requests.no_error_handling():
        request = requests.post(
            "https://scratch.mit.edu/login/",
            json={"username": username, "password": password},
            headers=_headers,
            timeout=timeout,
        )

    try:
        result = re.search('"(.*)"', request.headers["Set-Cookie"])
        assert result is not None
        session_id = str(result.group())
    except Exception:
        raise exceptions.LoginFailure(
            "Either the provided authentication data is wrong or your network is banned from Scratch.\n\nIf you're using an online IDE (like replit.com) Scratch possibly banned its IP address. In this case, try logging in with your session id: https://github.com/TimMcCool/scratchattach/wiki#logging-in"
        )

    # Create session object:
    with suppress_login_warning():
        return login_by_id(session_id, username=username, password=password)


def login_by_session_string(session_string: str) -> Session: