lms.cli.common

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