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

« back to all changes in this revision

Viewing changes to ivle/worksheet/utils.py

  • Committer: William Grant
  • Date: 2010-02-15 01:12:46 UTC
  • Revision ID: grantw@unimelb.edu.au-20100215011246-2kxz9ro0gnrvqueo
Document how to tag releases in bzr.

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
import os.path
 
27
 
26
28
from storm.locals import And, Asc, Desc, Store
27
29
import genshi
28
30
 
29
31
import ivle.database
30
32
from ivle.database import ExerciseAttempt, ExerciseSave, Worksheet, \
31
33
                          WorksheetExercise, Exercise
 
34
import ivle.webapp.tutorial.test
32
35
 
33
 
__all__ = ['get_exercise_status', 'get_exercise_stored_text',
34
 
           'get_exercise_attempts', 'get_exercise_attempt',
 
36
__all__ = ['ExerciseNotFound', 'get_exercise_status',
 
37
           'get_exercise_stored_text', 'get_exercise_attempts',
 
38
           'get_exercise_attempt', 'test_exercise_submission',
35
39
          ]
36
40
 
37
 
def get_exercise_status(store, user, worksheet_exercise):
 
41
class ExerciseNotFound(Exception):
 
42
    pass
 
43
 
 
44
def get_exercise_status(store, user, worksheet_exercise, as_of=None):
38
45
    """Given a storm.store, User and Exercise, returns information about
39
46
    the user's performance on that problem.
 
47
    @param store: A storm.store
 
48
    @param user: A User.
 
49
    @param worksheet_exercise: An Exercise.
 
50
    @param as_of: Optional datetime. If supplied, gets the status as of as_of.
40
51
    Returns a tuple of:
41
52
        - A boolean, whether they have successfully passed this exercise.
42
53
        - An int, the number of attempts they have made up to and
48
59
    is_relevant = ((ExerciseAttempt.user_id == user.id) &
49
60
            (ExerciseAttempt.ws_ex_id == worksheet_exercise.id) &
50
61
            (ExerciseAttempt.active == True))
 
62
    if as_of is not None:
 
63
        is_relevant &= ExerciseAttempt.date <= as_of
51
64
 
52
65
    # Get the first successful active attempt, or None if no success yet.
53
66
    # (For this user, for this exercise).
162
175
    saved.date = date
163
176
    saved.text = text
164
177
 
165
 
def calculate_score(store, user, worksheet):
 
178
def calculate_score(store, user, worksheet, as_of=None):
166
179
    """
167
180
    Given a storm.store, User, Exercise and Worksheet, calculates a score for
168
181
    the user on the given worksheet.
 
182
    @param store: A storm.store
 
183
    @param user: A User.
 
184
    @param worksheet: A Worksheet.
 
185
    @param as_of: Optional datetime. If supplied, gets the score as of as_of.
169
186
    Returns a 4-tuple of ints, consisting of:
170
187
    (No. mandatory exercises completed,
171
188
     Total no. mandatory exercises,
183
200
        worksheet = worksheet_exercise.worksheet
184
201
        optional = worksheet_exercise.optional
185
202
 
186
 
        done, _ = get_exercise_status(store, user, worksheet_exercise)
 
203
        done, _ = get_exercise_status(store, user, worksheet_exercise, as_of)
187
204
        # done is a bool, whether this student has completed that problem
188
205
        if optional:
189
206
            opt_total += 1
194
211
 
195
212
    return mand_done, mand_total, opt_done, opt_total
196
213
 
 
214
def calculate_mark(mand_done, mand_total):
 
215
    """Calculate a subject mark, given the result of all worksheets.
 
216
    @param mand_done: The total number of mandatory exercises completed by
 
217
        some student, across all worksheets.
 
218
    @param mand_total: The total number of mandatory exercises across all
 
219
        worksheets in the offering.
 
220
    @return: (percent, mark, mark_total)
 
221
        percent: The percentage of exercises the student has completed, as an
 
222
            integer between 0 and 100 inclusive.
 
223
        mark: The mark the student has received, based on the percentage.
 
224
        mark_total: The total number of marks available (currently hard-coded
 
225
            as 5).
 
226
    """
 
227
    # We want to display a students mark out of 5. However, they are
 
228
    # allowed to skip 1 in 5 questions and still get 'full marks'.
 
229
    # Hence we divide by 16, essentially making 16 percent worth
 
230
    # 1 star, and 80 or above worth 5.
 
231
    if mand_total > 0:
 
232
        percent_int = (100 * mand_done) // mand_total
 
233
    else:
 
234
        # Avoid Div0, just give everyone 0 marks if there are none available
 
235
        percent_int = 0
 
236
    # percent / 16, rounded down, with a maximum mark of 5
 
237
    max_mark = 5
 
238
    mark = min(percent_int // 16, max_mark)
 
239
    return (percent_int, mark, max_mark)
 
240
 
197
241
def update_exerciselist(worksheet):
198
242
    """Runs through the worksheetstream, generating the appropriate
199
243
    WorksheetExercises, and de-activating the old ones."""
231
275
                Exercise.id == exerciseid
232
276
            ).one()
233
277
            if exercise is None:
234
 
                raise NotFound()
 
278
                raise ExerciseNotFound(exerciseid)
235
279
            worksheet_exercise = WorksheetExercise()
236
280
            worksheet_exercise.worksheet_id = worksheet.id
237
281
            worksheet_exercise.exercise_id = exercise.id
240
284
        worksheet_exercise.seq_no = ex_num
241
285
        worksheet_exercise.optional = optional
242
286
 
 
287
 
 
288
def test_exercise_submission(config, user, exercise, code):
 
289
    """Test the given code against an exercise.
 
290
 
 
291
    The code is run in a console process as the provided user.
 
292
    """
 
293
    # Start a console to run the tests on
 
294
    jail_path = os.path.join(config['paths']['jails']['mounts'],
 
295
                             user.login)
 
296
    working_dir = os.path.join("/home", user.login)
 
297
    cons = ivle.console.Console(config, user.unixid, jail_path,
 
298
                                working_dir)
 
299
 
 
300
    # Parse the file into a exercise object using the test suite
 
301
    exercise_obj = ivle.webapp.tutorial.test.parse_exercise_file(
 
302
        exercise, cons)
 
303
 
 
304
    # Run the test cases. Get the result back as a JSONable object.
 
305
    # Return it.
 
306
    test_results = exercise_obj.run_tests(code)
 
307
 
 
308
    # Close the console
 
309
    cons.close()
 
310
 
 
311
    return test_results
 
312
 
 
313
 
 
314
class FakeWorksheetForMarks:
 
315
    """This class represents a worksheet and a particular students progress
 
316
    through it.
 
317
    
 
318
    Do not confuse this with a worksheet in the database. This worksheet
 
319
    has extra information for use in the output, such as marks."""
 
320
    def __init__(self, id, name, assessable):
 
321
        self.id = id
 
322
        self.name = name
 
323
        self.assessable = assessable
 
324
        self.complete_class = ''
 
325
        self.optional_message = ''
 
326
        self.total = 0
 
327
        self.mand_done = 0
 
328
    def __repr__(self):
 
329
        return ("Worksheet(id=%s, name=%s, assessable=%s)"
 
330
                % (repr(self.id), repr(self.name), repr(self.assessable)))
 
331
 
 
332
 
 
333
# XXX: This really shouldn't be needed.
 
334
def create_list_of_fake_worksheets_and_stats(store, user, offering):
 
335
    """Take an offering's real worksheets, converting them into stats.
 
336
 
 
337
    The worksheet listing views expect special fake worksheet objects
 
338
    that contain counts of exercises, whether they've been completed,
 
339
    that sort of thing. A fake worksheet object is used to contain
 
340
    these values, because nobody has managed to refactor the need out
 
341
    yet.
 
342
    """
 
343
    new_worksheets = []
 
344
    problems_done = 0
 
345
    problems_total = 0
 
346
 
 
347
    # Offering.worksheets is ordered by the worksheets seq_no
 
348
    for worksheet in offering.worksheets:
 
349
        new_worksheet = FakeWorksheetForMarks(
 
350
            worksheet.identifier, worksheet.name, worksheet.assessable)
 
351
        if new_worksheet.assessable:
 
352
            # Calculate the user's score for this worksheet
 
353
            mand_done, mand_total, opt_done, opt_total = (
 
354
                ivle.worksheet.utils.calculate_score(store, user, worksheet))
 
355
            if opt_total > 0:
 
356
                optional_message = " (excluding optional exercises)"
 
357
            else:
 
358
                optional_message = ""
 
359
            if mand_done >= mand_total:
 
360
                new_worksheet.complete_class = "complete"
 
361
            elif mand_done > 0:
 
362
                new_worksheet.complete_class = "semicomplete"
 
363
            else:
 
364
                new_worksheet.complete_class = "incomplete"
 
365
            problems_done += mand_done
 
366
            problems_total += mand_total
 
367
            new_worksheet.mand_done = mand_done
 
368
            new_worksheet.total = mand_total
 
369
            new_worksheet.optional_message = optional_message
 
370
        new_worksheets.append(new_worksheet)
 
371
 
 
372
    return new_worksheets, problems_total, problems_done