autograder.cli.courses.users.get

Get information about a course user.

usage: python3 -m autograder.cli.courses.users.get [-h] [--version]
                                                   [--server SERVER]
                                                   [--course COURSE]
                                                   [--user USER] [--pass PASS]
                                                   [--target-email TARGET_EMAIL]
                                                   [--testing-mode]
                                                   [--format {json,table,text}]
                                                   [--include-extra-fields]
                                                   [--pretty-headers]
                                                   [--skip-headers]

Get information about a course user.

options:
    -h, --help          show this help message and exit
    --version           show program's version number and exit

command-specific options:
    --server SERVER     The URL of the autograder server to communicate with.
    --course COURSE     The ID of the course to make this request to.
    --user USER         The email of the user making this request.
    --pass PASS         The password of the user making this request.
    --target-email TARGET_EMAIL
                        The email of the user that is the target of this
                        request (defaults to you). (default: None)

testing options:
    --testing-mode      Run as if a test is being run (default: False).

output formatting options:
    --format {json,table,text}
                        The format to display the output as (default: text).
    --include-extra-fields
                        Include uncommon fields in results (default: False).
    --pretty-headers    When displaying headers, try to make them look
                        "pretty" (default: False).
    --skip-headers      Skip headers when outputting results, will not apply
                        to all formats (default: False).

 1"""
 2Get information about a course user.
 3"""
 4
 5import argparse
 6import sys
 7
 8import lms.model.base
 9
10import autograder.api.courses.users.get
11import autograder.cli.parser
12
13def run_cli(args: argparse.Namespace) -> int:
14    """ Run the CLI. """
15
16    config = args._config_info.application_config
17
18    user = autograder.api.courses.users.get.send(config, exit_on_error = True)
19
20    users = []
21    if (user is not None):
22        users = [user]
23
24    output = lms.model.base.base_list_to_output_format(users, config.output_format,
25            skip_headers = args.skip_headers,
26            pretty_headers = args.pretty_headers,
27            include_extra_fields = args.include_extra_fields,
28    )
29    print(output)
30
31    return 0
32
33def main() -> int:
34    """ Get a parser, parse the args, and call run. """
35
36    return run_cli(_get_parser().parse_args())
37
38def _get_parser() -> argparse.ArgumentParser:
39    """ Get a parser for this operation. """
40
41    parser = autograder.cli.parser.get_parser(
42        __doc__.strip(),
43        autograder.api.courses.users.get.API_PARAMS,
44        include_output_format = True)
45
46    return parser
47
48if (__name__ == '__main__'):
49    sys.exit(main())
def run_cli(args: argparse.Namespace) -> int: 
14def run_cli(args: argparse.Namespace) -> int:
15    """ Run the CLI. """
16
17    config = args._config_info.application_config
18
19    user = autograder.api.courses.users.get.send(config, exit_on_error = True)
20
21    users = []
22    if (user is not None):
23        users = [user]
24
25    output = lms.model.base.base_list_to_output_format(users, config.output_format,
26            skip_headers = args.skip_headers,
27            pretty_headers = args.pretty_headers,
28            include_extra_fields = args.include_extra_fields,
29    )
30    print(output)
31
32    return 0

Run the CLI.

def main() -> int: 
34def main() -> int:
35    """ Get a parser, parse the args, and call run. """
36
37    return run_cli(_get_parser().parse_args())

Get a parser, parse the args, and call run.