autograder.api.users.get

Get information about a server user.

View Source

 1"""
 2Get information about a server user.
 3"""
 4
 5import typing
 6
 7import lms.model.users
 8
 9import autograder.api.common
10import autograder.api.config
11import autograder.model.config
12import autograder.model.user
13
14API_ENDPOINT: str = 'users/get'
15API_WRITE: bool = False
16API_PARAMS: typing.List[autograder.api.config.APIParam] = [
17    autograder.api.config.PARAM_SERVER,
18    autograder.api.config.PARAM_USER_EMAIL,
19    autograder.api.config.PARAM_USER_PASS,
20
21    autograder.api.config.PARAM_TARGET_EMAIL_OR_SELF,
22]
23
24def send(config: autograder.model.config.Config, **kwargs: typing.Any) -> typing.Union[lms.model.users.ServerUser, None]:
25    """ Send a request to the autograder. """
26
27    response = autograder.api.common.make_api_request(API_ENDPOINT, config, API_PARAMS, write = API_WRITE, **kwargs)
28
29    if (not response.get('found', False)):
30        return None
31
32    return autograder.model.user.make_server_user(response['user'])

API_ENDPOINT: str = 'users/get'

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>]

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

25def send(config: autograder.model.config.Config, **kwargs: typing.Any) -> typing.Union[lms.model.users.ServerUser, None]:
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    if (not response.get('found', False)):
31        return None
32
33    return autograder.model.user.make_server_user(response['user'])

Send a request to the autograder.