lms.cli.courses.groupsets.memberships.subtract

Subtract users from a group set.

usage: python3 -m lms.cli.courses.groupsets.memberships.subtract
       [-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

Subtract users from 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).

View Source

 1"""
 2Subtract users from 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_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 = lms.cli.courses.groupsets.memberships.common.load_group_memberships(backend, args.path, args.skip_rows)
29
30    counts = backend.courses_groupsets_memberships_resolve_and_subtract(course_query, groupset_query, memberships)
31
32    total_count = 0
33    for (group_query, count) in counts.items():
34        print(f"Subtracted {count} users from group {group_query}.")
35        total_count += count
36
37    return lms.cli.common.strict_check(config, (total_count != len(memberships)),
38        f"Expected to subtract {len(memberships)} memberships from groupset, but subtracted {total_count}.", 3)
39
40def main() -> int:
41    """ Get a parser, parse the args, and call run. """
42    return run_cli(_get_parser().parse_args())
43
44def _get_parser() -> argparse.ArgumentParser:
45    """ Get the parser. """
46
47    parser = lms.cli.parser.get_parser(__doc__.strip(),
48            include_output_format = True,
49            include_course = True,
50            include_groupset = True,
51            include_group = True,
52            include_skip_rows = True,
53            include_strict = True,
54    )
55
56    parser.add_argument('path', metavar = 'PATH',
57        action = 'store', type = str,
58        help = 'Path to a TSV file where each row has 2 columns: group query and user query.')
59
60    return parser
61
62if (__name__ == '__main__'):
63    sys.exit(main())

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

15def run_cli(args: argparse.Namespace) -> int:
16    """ Run the CLI. """
17
18    config = args._config_info.application_config
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    counts = backend.courses_groupsets_memberships_resolve_and_subtract(course_query, groupset_query, memberships)
32
33    total_count = 0
34    for (group_query, count) in counts.items():
35        print(f"Subtracted {count} users from group {group_query}.")
36        total_count += count
37
38    return lms.cli.common.strict_check(config, (total_count != len(memberships)),
39        f"Expected to subtract {len(memberships)} memberships from groupset, but subtracted {total_count}.", 3)

Run the CLI.

def main() -> int: View Source

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

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