lms.cli.courses.groupsets.memberships.set

Set membership for a group set.

usage: python3 -m lms.cli.courses.groupsets.memberships.set
       [-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] [--skip-rows SKIP_ROWS] [--strict]
       PATH

Set membership for a group set.

positional arguments:
  PATH                  Path to a TSV file where each row has 2 columns: group
                        query and user query.

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.
  --skip-rows SKIP_ROWS
                        The number of header rows to skip (default: 0).
  --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"""
 2Set membership for a group set.
 3"""
 4
 5import argparse
 6import sys
 7
 8import lms.backend.instance
 9import lms.cli.common
10import lms.cli.courses.groupsets.memberships.common
11import lms.cli.parser
12import lms.model.base
13
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    memberships = lms.cli.courses.groupsets.memberships.common.load_group_memberships(backend, args.path, args.skip_rows)
30
31    stats = backend.courses_groupsets_memberships_resolve_and_set(course_query, groupset_query, memberships)
32    (created_groups, deleted_groups, add_counts, sub_counts) = stats
33
34    if (len(created_groups) > 0):
35        display_groups = [str(group.to_query()) for group in created_groups]
36        print(f"Created {len(created_groups)} groups: {display_groups}.")
37
38    if (len(deleted_groups) > 0):
39        display_groups = [str(group_query) for group_query in deleted_groups]
40        print(f"Deleted {len(deleted_groups)} groups: {display_groups}.")
41
42    total_add_count = 0
43    for group_query in sorted(set(add_counts.keys()) | set(sub_counts.keys())):
44        add_count = add_counts.get(group_query, 0)
45        sub_count = sub_counts.get(group_query, 0)
46
47        print(f"Added {add_count} and subtracted {sub_count} users to/from group {group_query}.")
48        total_add_count += add_count
49
50    return lms.cli.common.strict_check(args.strict, (total_add_count != len(memberships)),
51        f"Expected to set {len(memberships)} memberships in groupset, but set {total_add_count}.", 3)
52
53def main() -> int:
54    """ Get a parser, parse the args, and call run. """
55    return run_cli(_get_parser().parse_args())
56
57def _get_parser() -> argparse.ArgumentParser:
58    """ Get the parser. """
59
60    parser = lms.cli.parser.get_parser(__doc__.strip(),
61            include_output_format = True,
62            include_course = True,
63            include_groupset = True,
64            include_group = True,
65            include_skip_rows = True,
66            include_strict = True,
67    )
68
69    parser.add_argument('path', metavar = 'PATH',
70        action = 'store', type = str,
71        help = 'Path to a TSV file where each row has 2 columns: group query and user query.')
72
73    return parser
74
75if (__name__ == '__main__'):
76    sys.exit(main())
def run_cli(args: argparse.Namespace) -> int: 
15def run_cli(args: argparse.Namespace) -> int:
16    """ Run the CLI. """
17
18    config = args._config
19
20    backend = lms.backend.instance.get_backend(**config)
21
22    course_query = lms.cli.common.check_required_course(backend, config)
23    if (course_query is None):
24        return 1
25
26    groupset_query = lms.cli.common.check_required_groupset(backend, config)
27    if (groupset_query is None):
28        return 2
29
30    memberships = lms.cli.courses.groupsets.memberships.common.load_group_memberships(backend, args.path, args.skip_rows)
31
32    stats = backend.courses_groupsets_memberships_resolve_and_set(course_query, groupset_query, memberships)
33    (created_groups, deleted_groups, add_counts, sub_counts) = stats
34
35    if (len(created_groups) > 0):
36        display_groups = [str(group.to_query()) for group in created_groups]
37        print(f"Created {len(created_groups)} groups: {display_groups}.")
38
39    if (len(deleted_groups) > 0):
40        display_groups = [str(group_query) for group_query in deleted_groups]
41        print(f"Deleted {len(deleted_groups)} groups: {display_groups}.")
42
43    total_add_count = 0
44    for group_query in sorted(set(add_counts.keys()) | set(sub_counts.keys())):
45        add_count = add_counts.get(group_query, 0)
46        sub_count = sub_counts.get(group_query, 0)
47
48        print(f"Added {add_count} and subtracted {sub_count} users to/from group {group_query}.")
49        total_add_count += add_count
50
51    return lms.cli.common.strict_check(args.strict, (total_add_count != len(memberships)),
52        f"Expected to set {len(memberships)} memberships in groupset, but set {total_add_count}.", 3)

Run the CLI.

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

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