lms.cli.courses.groupsets.memberships.list

List the membership of a group set.

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

List the membership of a group set.

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.
    --groupset GROUPSET
                        The group set to target for this operation.

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).

View Source

 1"""
 2List the membership of a group set.
 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    groupset_query = lms.cli.common.check_required_groupset(backend, config)
24    if (groupset_query is None):
25        return 2
26
27    memberships = backend.courses_groupsets_memberships_resolve_and_list(course_query, groupset_query)
28
29    output = lms.model.base.base_list_to_output_format(memberships, config.output_format,
30            skip_headers = args.skip_headers,
31            pretty_headers = args.pretty_headers,
32            include_extra_fields = args.include_extra_fields,
33    )
34
35    print(output)
36
37    return 0
38
39def main() -> int:
40    """ Get a parser, parse the args, and call run. """
41    return run_cli(_get_parser().parse_args())
42
43def _get_parser() -> argparse.ArgumentParser:
44    """ Get the parser. """
45
46    return lms.cli.parser.get_parser(__doc__.strip(),
47        include_output_format = True,
48        include_course = True,
49        include_groupset = True,
50    )
51
52if (__name__ == '__main__'):
53    sys.exit(main())

def run_cli(args: argparse.Namespace) -> int: View Source

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    groupset_query = lms.cli.common.check_required_groupset(backend, config)
25    if (groupset_query is None):
26        return 2
27
28    memberships = backend.courses_groupsets_memberships_resolve_and_list(course_query, groupset_query)
29
30    output = lms.model.base.base_list_to_output_format(memberships, config.output_format,
31            skip_headers = args.skip_headers,
32            pretty_headers = args.pretty_headers,
33            include_extra_fields = args.include_extra_fields,
34    )
35
36    print(output)
37
38    return 0

Run the CLI.

def main() -> int: View Source

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

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