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