Skip to content

Problem Extras like gs_connect

Gradescope Connect API

The Gradescope connect decorator and helpers.

GSConnectConfig dataclass

The configuration for Gradescope connect.

Source code in src/gapper/core/problem/extras/gradescope_connect.py 
16
17
18
19
20
21
@dataclass(frozen=True)
class GSConnectConfig:
    """The configuration for Gradescope connect."""

    cid: str
    aid: str

build_connect_config 

build_connect_config(url_or_cid: str, aid: str | None = None) -> GSConnectConfig

Build the connect arguments.

Parameters:

Name Type Description Default
url_or_cid str

The url when aid is not specified, or the course id of the Gradescope assignment. The format of the url should be https://www.gradescope.com/courses//assignments/[anything] connect('12443', '112358') # specify cid and aid connect('https://www.gradescope.com/courses/12443/assignments/112358') # specify url

 required
aid str | None

The assignment id of the Gradescope assignment. It should be specified when url_or_cid is a cid.

 None
Source code in src/gapper/core/problem/extras/gradescope_connect.py 
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
def build_connect_config(url_or_cid: str, aid: str | None = None) -> GSConnectConfig:
    """Build the connect arguments.

    :param url_or_cid: The url when aid is not specified, or the course id of the Gradescope assignment.
        The format of the url should be
        https://www.gradescope.com/courses/<cid>/assignments/<aid>[anything]

                connect('12443', '112358')  # specify cid and aid
                connect('https://www.gradescope.com/courses/12443/assignments/112358')  # specify url

    :param aid: The assignment id of the Gradescope assignment. It should be specified when url_or_cid is a cid.
    """
    if aid is None:
        url = url_or_cid
        cid, aid = extract_cid_aid_from_url(url)
        _gs_connect_logger.debug(f"Extracted cid {cid} and aid {aid} from url {url}")
    else:
        cid = url_or_cid
        _gs_connect_logger.debug(f"Using cid {cid} and aid {aid} from user input.")

    if not cid or not aid:
        raise ValueError(
            "Must specify both cid and aid at the same time. Or specify a url."
        )
    if (
        not cid.isdigit() or not aid.isdigit()
    ):  # not perfect for 0-9 checking but it's fine
        raise ValueError("cid and aid must be digits.")

    return GSConnectConfig(cid=cid, aid=aid)

gs_connect 

gs_connect(url_or_cid: str, aid: str | None = None) -> Callable[[T], T]

Connect a problem to a Gradescope assignment.

Parameters:

Name Type Description Default
url_or_cid str

The course id of the Gradescope assignment, or the url when aid is not specified. The format of the url should be https://www.gradescope.com/courses//assignments/[anything] connect('12443', '112358') # specify cid and aid connect('https://www.gradescope.com/courses/12443/assignments/112358') # specify url

 required
aid str | None

The assignment id of the Gradescope assignment.

 None
Source code in src/gapper/core/problem/extras/gradescope_connect.py 
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
def gs_connect[T: Problem](
    url_or_cid: str,
    aid: str | None = None,
) -> Callable[[T], T]:
    """Connect a problem to a Gradescope assignment.

    :param url_or_cid: The course id of the Gradescope assignment, or the url when aid is not specified.
        The format of the url should be
        https://www.gradescope.com/courses/<cid>/assignments/<aid>[anything]

            connect('12443', '112358')  # specify cid and aid
            connect('https://www.gradescope.com/courses/12443/assignments/112358')  # specify url

    :param aid: The assignment id of the Gradescope assignment.

    """
    gs_connect_config = build_connect_config(url_or_cid, aid)

    def _wrapper(prob: T) -> T:
        prob.config.extras["gs_connect"] = gs_connect_config
        return prob

    return _wrapper