lms.cli.courses.groups.memberships.set

Set users in a group to exactly match the listed users.

usage: python3 -m lms.cli.courses.groups.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]
                                                         [--strict]
                                                         [USER_QUERY ...]

Set users in a group to exactly match the listed users.

positional arguments:
  USER_QUERY            A query for a user to set in the 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.
  --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 users in a group to exactly match the listed users.
 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    user_queries = backend.parse_user_queries(args.users)
33
34    add_count, sub_count, _ = backend.courses_groups_memberships_resolve_and_set(course_query, groupset_query, group_query, user_queries)
35
36    print(f"Added {add_count} users to group {group_query}.")
37    print(f"Subtracted {sub_count} users from group {group_query}.")
38
39    return lms.cli.common.strict_check(args.strict, (add_count != len(user_queries)),
40        f"Expected to set {len(user_queries)} memberships in group, but set {add_count}.", 4)
41
42def main() -> int:
43    """ Get a parser, parse the args, and call run. """
44    return run_cli(_get_parser().parse_args())
45
46def _get_parser() -> argparse.ArgumentParser:
47    """ Get the parser. """
48
49    parser = lms.cli.parser.get_parser(__doc__.strip(),
50            include_output_format = True,
51            include_course = True,
52            include_groupset = True,
53            include_group = True,
54            include_strict = True,
55    )
56
57    parser.add_argument('users', metavar = 'USER_QUERY',
58        type = str, nargs = '*',
59        help = 'A query for a user to set in the group.')
60
61    return parser
62
63if (__name__ == '__main__'):
64    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    user_queries = backend.parse_user_queries(args.users)
34
35    add_count, sub_count, _ = backend.courses_groups_memberships_resolve_and_set(course_query, groupset_query, group_query, user_queries)
36
37    print(f"Added {add_count} users to group {group_query}.")
38    print(f"Subtracted {sub_count} users from group {group_query}.")
39
40    return lms.cli.common.strict_check(args.strict, (add_count != len(user_queries)),
41        f"Expected to set {len(user_queries)} memberships in group, but set {add_count}.", 4)

Run the CLI.

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

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