lms.cli.courses.groups.memberships.list

List the membership of a group.

usage: python3 -m lms.cli.courses.groups.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]
                                                          [--group GROUP]
                                                          [--format {json,table,text}]
                                                          [--include-extra-fields]
                                                          [--pretty-headers]
                                                          [--skip-headers]

List the membership of a group.

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.
  --group GROUP         The group 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).

 1"""
 2List the membership of a group.
 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
17
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    group_query = lms.cli.common.check_required_group(backend, config)
29    if (group_query is None):
30        return 3
31
32    memberships = backend.courses_groups_memberships_resolve_and_list(course_query, groupset_query, group_query)
33
34    output = lms.model.base.base_list_to_output_format(memberships, args.output_format,
35            skip_headers = args.skip_headers,
36            pretty_headers = args.pretty_headers,
37            include_extra_fields = args.include_extra_fields,
38    )
39
40    print(output)
41
42    return 0
43
44def main() -> int:
45    """ Get a parser, parse the args, and call run. """
46    return run_cli(_get_parser().parse_args())
47
48def _get_parser() -> argparse.ArgumentParser:
49    """ Get the parser. """
50
51    return lms.cli.parser.get_parser(__doc__.strip(),
52            include_output_format = True,
53            include_course = True,
54            include_groupset = True,
55            include_group = True,
56    )
57
58if (__name__ == '__main__'):
59    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
18
19    backend = lms.backend.instance.get_backend(**config)
20
21    course_query = lms.cli.common.check_required_course(backend, config)
22    if (course_query is None):
23        return 1
24
25    groupset_query = lms.cli.common.check_required_groupset(backend, config)
26    if (groupset_query is None):
27        return 2
28
29    group_query = lms.cli.common.check_required_group(backend, config)
30    if (group_query is None):
31        return 3
32
33    memberships = backend.courses_groups_memberships_resolve_and_list(course_query, groupset_query, group_query)
34
35    output = lms.model.base.base_list_to_output_format(memberships, args.output_format,
36            skip_headers = args.skip_headers,
37            pretty_headers = args.pretty_headers,
38            include_extra_fields = args.include_extra_fields,
39    )
40
41    print(output)
42
43    return 0

Run the CLI.

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

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