lms.cli.common

  1import typing
  2
  3import lms.model.backend
  4import lms.model.assignments
  5import lms.model.courses
  6import lms.model.groupsets
  7import lms.model.users
  8import lms.util.parse
  9
 10def check_required_assignment(
 11        backend: lms.model.backend.APIBackend,
 12        config: typing.Dict[str, typing.Any],
 13        ) -> typing.Union[lms.model.assignments.AssignmentQuery, None]:
 14    """
 15    Fetch and ensure that an assignment is provided in the config.
 16    If no assignment is provided, print a message and return None.
 17    """
 18
 19    assignment = lms.util.parse.optional_string(config.get('assignment', None))
 20    if (assignment is None):
 21        print('ERROR: No assignment has been provided.')
 22        return None
 23
 24    query = backend.parse_assignment_query(assignment)
 25    if (query is None):
 26        print('ERROR: Assignment query is malformed.')
 27        return None
 28
 29    return query
 30
 31def check_required_course(
 32        backend: lms.model.backend.APIBackend,
 33        config: typing.Dict[str, typing.Any],
 34        ) -> typing.Union[lms.model.courses.CourseQuery, None]:
 35    """
 36    Fetch and ensure that a course is provided in the config.
 37    If no course is provided, print a message and return None.
 38    """
 39
 40    course = lms.util.parse.optional_string(config.get('course', None))
 41    if (course is None):
 42        print('ERROR: No course has been provided.')
 43        return None
 44
 45    query = backend.parse_course_query(course)
 46    if (query is None):
 47        print('ERROR: Course query is malformed.')
 48        return None
 49
 50    return query
 51
 52def check_required_groupset(
 53        backend: lms.model.backend.APIBackend,
 54        config: typing.Dict[str, typing.Any],
 55        ) -> typing.Union[lms.model.groupsets.GroupSetQuery, None]:
 56    """
 57    Fetch and ensure that a group set is provided in the config.
 58    If no group set is provided, print a message and return None.
 59    """
 60
 61    groupset = lms.util.parse.optional_string(config.get('groupset', None))
 62    if (groupset is None):
 63        print('ERROR: No group set has been provided.')
 64        return None
 65
 66    query = backend.parse_groupset_query(groupset)
 67    if (query is None):
 68        print('ERROR: Group set query is malformed.')
 69        return None
 70
 71    return query
 72
 73def check_required_group(
 74        backend: lms.model.backend.APIBackend,
 75        config: typing.Dict[str, typing.Any],
 76        ) -> typing.Union[lms.model.groups.GroupQuery, None]:
 77    """
 78    Fetch and ensure that a group is provided in the config.
 79    If no group is provided, print a message and return None.
 80    """
 81
 82    group = lms.util.parse.optional_string(config.get('group', None))
 83    if (group is None):
 84        print('ERROR: No group has been provided.')
 85        return None
 86
 87    query = backend.parse_group_query(group)
 88    if (query is None):
 89        print('ERROR: Group query is malformed.')
 90        return None
 91
 92    return query
 93
 94def check_required_user(
 95        backend: lms.model.backend.APIBackend,
 96        config: typing.Dict[str, typing.Any],
 97        ) -> typing.Union[lms.model.users.UserQuery, None]:
 98    """
 99    Fetch and ensure that a user is provided in the config.
100    If no user is provided, print a message and return None.
101    """
102
103    user = lms.util.parse.optional_string(config.get('user', None))
104    if (user is None):
105        print('ERROR: No user has been provided.')
106        return None
107
108    query = backend.parse_user_query(user)
109    if (query is None):
110        print('ERROR: User query is malformed.')
111        return None
112
113    return query
114
115DEFAULT_STRICT_EXIT_CODE: int = 101
116
117def strict_check(
118        strict: bool,
119        has_error: bool,
120        message: str,
121        exit_code: int = DEFAULT_STRICT_EXIT_CODE,
122        ) -> int:
123    """
124    Check if strict mode is enabled and if the operation encountered an error.
125    If strict mode is triggered, print an error message and return a suggested exit status.
126    Otherwise, return 0.
127    """
128
129    if (not strict):
130        return 0
131
132    if (has_error):
133        print(f"ERROR (Strict Mode): {message}")
134        return exit_code
135
136    return 0