autograder.api.courses.users.list

List the users in a course.

View Source

 1"""
 2List the users in a course.
 3"""
 4
 5import typing
 6
 7import lms.model.users
 8
 9import autograder.api.common
10import autograder.api.config
11import autograder.model.user
12import autograder.model.config
13
14API_ENDPOINT: str = 'courses/users/list'
15API_WRITE: bool = False
16API_PARAMS: typing.List[autograder.api.config.APIParam] = [
17    autograder.api.config.PARAM_SERVER,
18    autograder.api.config.PARAM_COURSE,
19    autograder.api.config.PARAM_USER_EMAIL,
20    autograder.api.config.PARAM_USER_PASS,
21
22    autograder.api.config.PARAM_TARGET_USERS,
23]
24
25def send(config: autograder.model.config.Config, **kwargs: typing.Any) -> typing.List[lms.model.users.ServerUser]:
26    """ Send a request to the autograder. """
27
28    response = autograder.api.common.make_api_request(API_ENDPOINT, config, API_PARAMS, write = API_WRITE, **kwargs)
29
30    users = []
31    for raw_user in response['users']:
32        users.append(autograder.model.user.make_course_user(raw_user))
33
34    return sorted(users)

API_ENDPOINT: str = 'courses/users/list'

API_WRITE: bool = False

API_PARAMS: List[autograder.api.config.APIParam] = [<autograder.api.config.APIParam object>, <autograder.api.config.APIParam object>, <autograder.api.config.APIParam object>, <autograder.api.config.APIParam object>, <autograder.api.config.APIParam object>]

def send( config: autograder.model.config.Config, **kwargs: Any) -> List[lms.model.users.ServerUser]: View Source

26def send(config: autograder.model.config.Config, **kwargs: typing.Any) -> typing.List[lms.model.users.ServerUser]:
27    """ Send a request to the autograder. """
28
29    response = autograder.api.common.make_api_request(API_ENDPOINT, config, API_PARAMS, write = API_WRITE, **kwargs)
30
31    users = []
32    for raw_user in response['users']:
33        users.append(autograder.model.user.make_course_user(raw_user))
34
35    return sorted(users)

Send a request to the autograder.