lms.cli.courses.users.get

Get specific users of a course.

usage: python3 -m lms.cli.courses.users.get [-h] [--version] [--server SERVER]
                                            [--server-type {blackboard,canvas,moodle}]
                                            [--auth-user AUTH_USER]
                                            [--auth-password AUTH_PASSWORD]
                                            [--auth-token AUTH_TOKEN]
                                            [--course COURSE]
                                            [--format {json,table,text}]
                                            [--include-extra-fields]
                                            [--pretty-headers]
                                            [--skip-headers] [--strict]
                                            [USER_QUERY ...]

Get specific users of a course.

positional arguments:
    USER_QUERY          A query for a user to get.

options:
    -h, --help          show this help message and exit
    --version           show program's version number and exit
    --course COURSE     The course to target for this operation.
    --strict            Enable strict mode, which is stricter about what
                        counts as an error (default: False).

server options:
    --server SERVER     The address of the LMS server to connect to.
    --server-type {blackboard,canvas,moodle}
                        The type of LMS being connected to (this can normally
                        be guessed from the server address).

authentication options:
    --auth-user AUTH_USER
                        The user to authenticate with.
    --auth-password AUTH_PASSWORD
                        The password to authenticate with.
    --auth-token AUTH_TOKEN
                        The token to authenticate with.

output formatting options:
    --format {json,table,text}
                        The format to display the output as (default: text).
    --include-extra-fields
                        Include non-common (usually LMS-specific) 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 specific users of a course.
 3"""
 4
 5import argparse
 6import sys
 7
 8import lms.backend.instance
 9import lms.cli.common
10import lms.cli.parser
11import lms.model.base
12
13def run_cli(args: argparse.Namespace) -> int:
14    """ Run the CLI. """
15
16    config = args._config_info.application_config
17    backend = lms.backend.instance.get_backend(config)
18
19    course_query = lms.cli.common.check_required_course(backend, config)
20    if (course_query is None):
21        return 1
22
23    queries = backend.parse_user_queries(args.users)
24
25    users = backend.courses_users_get(course_query, queries)
26
27    output = lms.model.base.base_list_to_output_format(users, config.output_format,
28            skip_headers = args.skip_headers,
29            pretty_headers = args.pretty_headers,
30            include_extra_fields = args.include_extra_fields,
31    )
32
33    print(output)
34
35    return lms.cli.common.strict_check(config, (len(users) != len(queries)),
36        f"Expected to find {len(queries)} users, but found {len(users)}.", 2)
37
38def main() -> int:
39    """ Get a parser, parse the args, and call run. """
40    return run_cli(_get_parser().parse_args())
41
42def _get_parser() -> argparse.ArgumentParser:
43    """ Get the parser. """
44
45    parser = lms.cli.parser.get_parser(__doc__.strip(),
46            include_output_format = True,
47            include_course = True,
48            include_strict = True,
49    )
50
51    parser.add_argument('users', metavar = 'USER_QUERY',
52        type = str, nargs = '*',
53        help = 'A query for a user to get.')
54
55    return parser
56
57if (__name__ == '__main__'):
58    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    backend = lms.backend.instance.get_backend(config)
19
20    course_query = lms.cli.common.check_required_course(backend, config)
21    if (course_query is None):
22        return 1
23
24    queries = backend.parse_user_queries(args.users)
25
26    users = backend.courses_users_get(course_query, queries)
27
28    output = lms.model.base.base_list_to_output_format(users, config.output_format,
29            skip_headers = args.skip_headers,
30            pretty_headers = args.pretty_headers,
31            include_extra_fields = args.include_extra_fields,
32    )
33
34    print(output)
35
36    return lms.cli.common.strict_check(config, (len(users) != len(queries)),
37        f"Expected to find {len(queries)} users, but found {len(users)}.", 2)

Run the CLI.

def main() -> int: 
39def main() -> int:
40    """ Get a parser, parse the args, and call run. """
41    return run_cli(_get_parser().parse_args())

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