~azzar1/unity/add-show-desktop-key

« back to all changes in this revision

Viewing changes to ivle/worksheet.py

  • Committer: William Grant
  • Date: 2009-02-25 23:04:11 UTC
  • Revision ID: grantw@unimelb.edu.au-20090225230411-lbdyl32ir0m3d59b
Make all of the services executable.

Show diffs side-by-side

added added

removed removed

Lines of Context:
23
23
This module provides functions for tutorial and worksheet computations.
24
24
"""
25
25
 
26
 
from storm.locals import And, Asc, Desc
 
26
from storm.locals import And, Asc, Desc, Store
 
27
import genshi
 
28
 
27
29
import ivle.database
28
 
from ivle.database import ExerciseAttempt, ExerciseSave, Worksheet
 
30
from ivle.database import ExerciseAttempt, ExerciseSave, Worksheet, \
 
31
                          WorksheetExercise, Exercise
29
32
 
30
33
__all__ = ['get_exercise_status', 'get_exercise_stored_text',
31
34
           'get_exercise_attempts', 'get_exercise_attempt',
32
35
          ]
33
36
 
34
 
def get_exercise_status(store, user, exercise, worksheet):
 
37
def get_exercise_status(store, user, worksheet_exercise):
35
38
    """Given a storm.store, User and Exercise, returns information about
36
39
    the user's performance on that problem.
37
40
    Returns a tuple of:
43
46
    # A Storm expression denoting all active attempts by this user for this
44
47
    # exercise.
45
48
    is_relevant = ((ExerciseAttempt.user_id == user.id) &
46
 
                   (ExerciseAttempt.exercise_id == exercise.id) &
47
 
                   (ExerciseAttempt.active == True) &
48
 
                   (ExerciseAttempt.worksheetid == worksheet.id))
 
49
            (ExerciseAttempt.ws_ex_id == worksheet_exercise.id) &
 
50
            (ExerciseAttempt.active == True))
49
51
 
50
52
    # Get the first successful active attempt, or None if no success yet.
51
53
    # (For this user, for this exercise).
67
69
 
68
70
    return first_success is not None, num_attempts
69
71
 
70
 
def get_exercise_stored_text(store, user, exercise, worksheet):
71
 
    """Given a storm.store, User and Exercise, returns an
 
72
def get_exercise_stored_text(store, user, worksheet_exercise):
 
73
    """Given a storm.store, User and WorksheetExercise, returns an
72
74
    ivle.database.ExerciseSave object for the last saved/submitted attempt for
73
75
    this question (note that ExerciseAttempt is a subclass of ExerciseSave).
74
76
    Returns None if the user has not saved or made an attempt on this
80
82
    # Get the saved text, or None
81
83
    saved = store.find(ExerciseSave,
82
84
                ExerciseSave.user_id == user.id,
83
 
                ExerciseSave.exercise_id == exercise.id,
84
 
                ExerciseSave.worksheetid == worksheet.id).one()
 
85
                ExerciseSave.ws_ex_id == worksheet_exercise.id).one()
85
86
 
86
87
    # Get the most recent attempt, or None
87
88
    attempt = store.find(ExerciseAttempt,
88
89
            ExerciseAttempt.user_id == user.id,
89
 
            ExerciseAttempt.exercise_id == exercise.id,
90
 
            ExerciseAttempt.worksheetid == worksheet.id,
91
90
            ExerciseAttempt.active == True,
 
91
            ExerciseAttempt.ws_ex_id == worksheet_exercise.id
92
92
        ).order_by(Asc(ExerciseAttempt.date)).last()
93
93
 
94
94
    # Pick the most recent of these two
103
103
        else:
104
104
            return None
105
105
 
106
 
def _get_exercise_attempts(store, user, exercise, worksheet, as_of=None,
 
106
def _get_exercise_attempts(store, user, worksheet_exercise, as_of=None,
107
107
        allow_inactive=False):
108
108
    """Same as get_exercise_attempts, but doesn't convert Storm's iterator
109
109
    into a list."""
111
111
    # Get the most recent attempt before as_of, or None
112
112
    return store.find(ExerciseAttempt,
113
113
            ExerciseAttempt.user_id == user.id,
114
 
            ExerciseAttempt.exercise_id == exercise.id,
115
 
            ExerciseAttempt.worksheetid == worksheet.id,
 
114
            ExerciseAttempt.ws_ex_id == worksheet_exercise.id,
116
115
            True if allow_inactive else ExerciseAttempt.active == True,
117
116
            True if as_of is None else ExerciseAttempt.date <= as_of,
118
117
        ).order_by(Desc(ExerciseAttempt.date))
119
118
 
120
 
def get_exercise_attempts(store, user, exercise, worksheet, as_of=None,
 
119
def get_exercise_attempts(store, user, worksheet_exercise, as_of=None,
121
120
        allow_inactive=False):
122
121
    """Given a storm.store, User and Exercise, returns a list of
123
122
    ivle.database.ExerciseAttempt objects, one for each attempt made for the
127
126
        attempts made before or at this time.
128
127
    allow_inactive: If True, will return disabled attempts.
129
128
    """
130
 
    return list(_get_exercise_attempts(store, user, exercise, worksheet, as_of,
 
129
    return list(_get_exercise_attempts(store, user, worksheet_exercise, as_of,
131
130
        allow_inactive))
132
131
 
133
 
def get_exercise_attempt(store, user, exercise, worksheet, as_of=None,
 
132
def get_exercise_attempt(store, user, worksheet_exercise, as_of=None,
134
133
        allow_inactive=False):
135
 
    """Given a storm.store, User and Exercise, returns an
 
134
    """Given a storm.store, User and WorksheetExercise, returns an
136
135
    ivle.database.ExerciseAttempt object for the last submitted attempt for
137
136
    this question.
138
137
    Returns None if the user has not made an attempt on this
142
141
        attempts made before or at this time.
143
142
    allow_inactive: If True, will return disabled attempts.
144
143
    """
145
 
    return _get_exercise_attempts(store, user, exercise, worksheet, as_of,
 
144
    return _get_exercise_attempts(store, user, worksheet_exercise, as_of,
146
145
        allow_inactive).first()
147
146
 
148
 
def save_exercise(store, user, exercise, worksheet, text, date):
 
147
def save_exercise(store, user, worksheet_exercise, text, date):
149
148
    """Save an exercise for a user.
150
149
 
151
 
    Given a store, User, Exercise and text and date, save the text to the
 
150
    Given a store, User, WorksheetExercise, text and date, save the text to the
152
151
    database. This will create the ExerciseSave if needed.
153
152
    """
154
153
    saved = store.find(ivle.database.ExerciseSave,
155
154
                ivle.database.ExerciseSave.user_id == user.id,
156
 
                ivle.database.ExerciseSave.exercise_id == exercise.id,
157
 
                ivle.database.ExerciseSave.worksheetid == worksheet.id
 
155
                ivle.database.ExerciseSave.ws_ex_id == worksheet_exercise.id
158
156
                ).one()
159
157
    if saved is None:
160
 
        saved = ivle.database.ExerciseSave(user=user, exercise=exercise, 
161
 
                                           worksheet=worksheet)
 
158
        saved = ivle.database.ExerciseSave(user=user, 
 
159
                                        worksheet_exercise=worksheet_exercise)
162
160
        store.add(saved)
163
161
 
164
162
    saved.date = date
182
180
    # Get the student's pass/fail for each exercise in this worksheet
183
181
    for worksheet_exercise in worksheet.worksheet_exercises:
184
182
        exercise = worksheet_exercise.exercise
 
183
        worksheet = worksheet_exercise.worksheet
185
184
        optional = worksheet_exercise.optional
186
185
 
187
 
        done, _ = get_exercise_status(store, user, exercise)
 
186
        done, _ = get_exercise_status(store, user, worksheet_exercise)
188
187
        # done is a bool, whether this student has completed that problem
189
188
        if optional:
190
189
            opt_total += 1
194
193
            if done: mand_done += 1
195
194
 
196
195
    return mand_done, mand_total, opt_done, opt_total
 
196
 
 
197
def update_exerciselist(worksheet):
 
198
    """Runs through the worksheetstream, generating the appropriate
 
199
    WorksheetExercises, and de-activating the old ones."""
 
200
    exercises = []
 
201
    # Turns the worksheet into an xml stream, and then finds all the 
 
202
    # exercise nodes in the stream.
 
203
    worksheetdata = genshi.XML(worksheet.data)
 
204
    for kind, data, pos in worksheetdata:
 
205
        if kind is genshi.core.START:
 
206
            # Data is a tuple of tag name and a list of name->value tuples
 
207
            if data[0] == 'exercise':
 
208
                src = ""
 
209
                optional = False
 
210
                for attr in data[1]:
 
211
                    if attr[0] == 'src':
 
212
                        src = attr[1]
 
213
                    if attr[0] == 'optional':
 
214
                        optional = attr[1] == 'true'
 
215
                if src != "":
 
216
                    exercises.append((src, optional))
 
217
    ex_num = 0
 
218
    # Set all current worksheet_exercises to be inactive
 
219
    db_worksheet_exercises = Store.of(worksheet).find(WorksheetExercise,
 
220
        WorksheetExercise.worksheet_id == worksheet.id)
 
221
    for worksheet_exercise in db_worksheet_exercises:
 
222
        worksheet_exercise.active = False
 
223
    
 
224
    for exerciseid, optional in exercises:
 
225
        worksheet_exercise = Store.of(worksheet).find(WorksheetExercise,
 
226
            WorksheetExercise.worksheet_id == worksheet.id,
 
227
            Exercise.id == WorksheetExercise.exercise_id,
 
228
            Exercise.id == exerciseid).one()
 
229
        if worksheet_exercise is None:
 
230
            exercise = Store.of(worksheet).find(Exercise,
 
231
                Exercise.id == exerciseid
 
232
            ).one()
 
233
            if exercise is None:
 
234
                raise NotFound()
 
235
            worksheet_exercise = WorksheetExercise()
 
236
            worksheet_exercise.worksheet_id = worksheet.id
 
237
            worksheet_exercise.exercise_id = exercise.id
 
238
            Store.of(worksheet).add(worksheet_exercise)
 
239
        worksheet_exercise.active = True
 
240
        worksheet_exercise.seq_no = ex_num
 
241
        worksheet_exercise.optional = optional
 
242