/usr/lib/python2.7/dist-packages/schooltool/gradebook/gradebook.py is in python-schooltool.gradebook 2.6.3-0ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 | #
# SchoolTool - common information systems platform for school administration
# Copyright (c) 2005 Shuttleworth Foundation
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
#
"""
Gradebook Implementation
"""
__docformat__ = 'reStructuredText'
from decimal import Decimal
from persistent.dict import PersistentDict
from zope.security import proxy
from zope import annotation
from zope.keyreference.interfaces import IKeyReference
from zope.component import adapts, adapter
from zope.component import queryMultiAdapter, getMultiAdapter
from zope.component import getUtility
from zope.interface import implements, implementer, Interface
from zope.location.location import LocationProxy
from zope.publisher.interfaces import IPublishTraverse
from zope.security.proxy import removeSecurityProxy
from zope.intid.interfaces import IIntIds
from schooltool import course, requirement
from schooltool.app.interfaces import ISchoolToolApplication
from schooltool.basicperson.interfaces import IBasicPerson
from schooltool.export.export import XLSReportTask
from schooltool.report.report import ReportTask
from schooltool.securitypolicy.crowds import ConfigurableCrowd
from schooltool.securitypolicy.crowds import AdministratorsCrowd
from schooltool.gradebook import interfaces
from schooltool.gradebook.activity import getSourceObj
from schooltool.gradebook.activity import ensureAtLeastOneWorksheet
from schooltool.requirement.evaluation import Score
from schooltool.requirement.scoresystem import UNSCORED, ScoreValidationError
from schooltool.requirement.interfaces import IDiscreteValuesScoreSystem
from schooltool.requirement.interfaces import IRangedValuesScoreSystem
from schooltool.requirement.scoresystem import RangedValuesScoreSystem
GRADEBOOK_SORTING_KEY = 'schooltool.gradebook.sorting'
CURRENT_SECTION_TAUGHT_KEY = 'schooltool.gradebook.currentsectiontaught'
CURRENT_SECTION_ATTENDED_KEY = 'schooltool.gradebook.currentsectionattended'
DUE_DATE_FILTER_KEY = 'schooltool.gradebook.duedatefilter'
COLUMN_PREFERENCES_KEY = 'schooltool.gradebook.columnpreferences'
def getInstructorSections(person):
return list(course.interfaces.IInstructor(person).sections())
def getLearnerSections(person):
return list(course.interfaces.ILearner(person).sections())
def getCurrentSectionTaught(person):
person = proxy.removeSecurityProxy(person)
ann = annotation.interfaces.IAnnotations(person)
if CURRENT_SECTION_TAUGHT_KEY not in ann:
ann[CURRENT_SECTION_TAUGHT_KEY] = None
else:
section = ann[CURRENT_SECTION_TAUGHT_KEY]
if section not in getInstructorSections(person):
return None
try:
interfaces.IActivities(section)
except:
ann[CURRENT_SECTION_TAUGHT_KEY] = None
return ann[CURRENT_SECTION_TAUGHT_KEY]
def setCurrentSectionTaught(person, section):
person = proxy.removeSecurityProxy(person)
ann = annotation.interfaces.IAnnotations(person)
if section in getInstructorSections(person):
ann[CURRENT_SECTION_TAUGHT_KEY] = section
def getCurrentSectionAttended(person):
person = proxy.removeSecurityProxy(person)
ann = annotation.interfaces.IAnnotations(person)
if CURRENT_SECTION_ATTENDED_KEY not in ann:
ann[CURRENT_SECTION_ATTENDED_KEY] = None
else:
section = ann[CURRENT_SECTION_ATTENDED_KEY]
if section not in getLearnerSections(person):
return None
try:
interfaces.IActivities(section)
except:
ann[CURRENT_SECTION_ATTENDED_KEY] = None
return ann[CURRENT_SECTION_ATTENDED_KEY]
def setCurrentSectionAttended(person, section):
person = proxy.removeSecurityProxy(person)
ann = annotation.interfaces.IAnnotations(person)
if section in getLearnerSections(person):
ann[CURRENT_SECTION_ATTENDED_KEY] = section
class WorksheetGradebookTraverser(object):
'''Traverser that goes from a worksheet to the gradebook'''
implements(IPublishTraverse)
def __init__(self, context, request):
self.context = context
self.request = request
def publishTraverse(self, request, name):
context = proxy.removeSecurityProxy(self.context)
try:
activity = context[name]
return activity
except KeyError:
if name == 'gradebook':
gb = interfaces.IGradebook(context)
gb = LocationProxy(gb, self.context, name)
gb.__setattr__('__parent__', gb.__parent__)
return gb
elif name == 'mygrades':
gb = interfaces.IMyGrades(context)
gb = LocationProxy(gb, self.context, name)
gb.__setattr__('__parent__', gb.__parent__)
return gb
else:
return queryMultiAdapter((self.context, request), name=name)
class StudentGradebookTraverser(object):
'''Traverser that goes from a section's gradebook to a student
gradebook using the student's username as the path in the url.'''
implements(IPublishTraverse)
def __init__(self, context, request):
self.context = context
self.request = request
def publishTraverse(self, request, name):
app = ISchoolToolApplication(None)
context = removeSecurityProxy(self.context)
try:
student = app['persons'][name]
except KeyError:
return queryMultiAdapter((self.context, request), name=name)
try:
gb = getMultiAdapter((student, context), interfaces.IStudentGradebook)
except ValueError:
return queryMultiAdapter((self.context, request), name=name)
# location looks like http://host/path/to/gradebook/studentsUsername
gb = LocationProxy(gb, self.context, name)
return gb
@adapter(requirement.interfaces.IHaveEvaluations,
interfaces.IActivity)
@implementer(requirement.interfaces.IScore)
def getActivityScore(evaluatee, activity):
evaluations = requirement.interfaces.IEvaluations(evaluatee)
evaluation = evaluations.get(activity, None)
if evaluation is None:
return None
return requirement.interfaces.IScore(evaluation)
@adapter(requirement.interfaces.IHaveEvaluations,
interfaces.ILinkedColumnActivity)
@implementer(requirement.interfaces.IScore)
def getLinkedActivityScore(evaluatee, activity):
source = getSourceObj(activity.source)
score = queryMultiAdapter(
(evaluatee, source),
requirement.interfaces.IScore,
default=None)
return score
@adapter(requirement.interfaces.IHaveEvaluations,
interfaces.IActivityWorksheet)
@implementer(requirement.interfaces.IScore)
def getWorksheetAverageScore(evaluatee, worksheet):
gradebook = interfaces.IGradebook(worksheet)
if evaluatee not in gradebook.students:
return None
total, value = gradebook.getWorksheetTotalAverage(worksheet, evaluatee)
score_system = RangedValuesScoreSystem()
score = Score(score_system, value)
# Set the __parent__ for security mechanism
# Let's assume that if you can look at the worksheet, you
# can also look at the average grades in that worksheet.
score.__parent__ = worksheet
return score
def canAverage(worksheet, containing=None):
if containing is None:
containing = worksheet
for activity in worksheet.values():
linked_act = interfaces.ILinkedColumnActivity(activity, None)
if linked_act is not None:
source = getSourceObj(linked_act.source)
linked_ws = interfaces.IWorksheet(source, None)
if linked_ws is not None:
linked_ws = proxy.removeSecurityProxy(linked_ws)
if (linked_ws is proxy.removeSecurityProxy(containing) or
not canAverage(linked_ws, containing)):
return False
return True
class GradebookBase(object):
def __init__(self, context):
self.context = context
# To make URL creation happy
self.__parent__ = context
self.section = self.context.__parent__.__parent__
# Establish worksheets and all activities
worksheets = interfaces.IActivities(self.section)
ensureAtLeastOneWorksheet(worksheets)
self.worksheets = list(worksheets.values())
self.activities = []
for activity in context.values():
self.activities.append(activity)
self.students = list(self.section.members)
def _checkStudent(self, student):
if student not in self.students:
raise ValueError(
'Student %r is not in this section.' %student.username)
# Remove security proxy, so that the object can be referenced and
# adapters are not proxied. Note that the gradebook itself has
# sufficient tight security.
return proxy.removeSecurityProxy(student)
def _checkActivity(self, activity):
# Remove security proxy, so that the object can be referenced and
# adapters are not proxied. Note that the gradebook itself has
# sufficient tight security.
if activity in self.activities:
return proxy.removeSecurityProxy(activity)
raise ValueError(
'%r is not part of this section.' %activity.title)
def hasEvaluation(self, student, activity):
"""See interfaces.IGradebook"""
student = self._checkStudent(student)
activity = self._checkActivity(activity)
evaluations = requirement.interfaces.IEvaluations(student)
evaluation = evaluations.get(activity, None)
if not (evaluation is None or
evaluation.value is UNSCORED):
return True
return False
def getScore(self, student, activity):
"""See interfaces.IGradebook"""
student = self._checkStudent(student)
activity = self._checkActivity(activity)
score = queryMultiAdapter(
(student, activity),
requirement.interfaces.IScore,
default=None)
return score
def evaluate(self, student, activity, score, evaluator=None):
"""See interfaces.IGradebook"""
student = self._checkStudent(student)
activity = self._checkActivity(activity)
evaluation = requirement.evaluation.Evaluation(
activity, activity.scoresystem, score, evaluator)
evaluations = requirement.interfaces.IEvaluations(student)
current = evaluations.get(activity)
if current is not None:
evaluation.previous = current
evaluations.addEvaluation(evaluation)
def removeEvaluation(self, student, activity, evaluator=None):
"""See interfaces.IGradebook"""
student = self._checkStudent(student)
activity = self._checkActivity(activity)
evaluations = requirement.interfaces.IEvaluations(student)
unscored = requirement.evaluation.Evaluation(
activity, activity.scoresystem, UNSCORED, evaluator)
# throw KeyError here, like "del evaluations[activity]" would have
previous = evaluations.get(activity)
if previous is not None:
unscored.previous = evaluations[activity]
evaluations.addEvaluation(unscored)
def getWorksheetActivities(self, worksheet):
if worksheet:
return list(worksheet.values())
else:
return []
def getWorksheetTotalAverage(self, worksheet, student):
def getMinMaxValue(score):
ss = score.scoreSystem
if IDiscreteValuesScoreSystem.providedBy(ss):
return (ss.scores[-1][2], ss.scores[0][2],
ss.getNumericalValue(score.value))
elif IRangedValuesScoreSystem.providedBy(ss):
return ss.min, ss.max, score.value
return None, None, None
if worksheet is None or not canAverage(worksheet):
return 0, UNSCORED
# XXX: move this to gradebook adapter for GenericWorksheet
weights = None
if hasattr(worksheet, 'getCategoryWeights'):
weights = worksheet.getCategoryWeights()
# weight by categories
if weights:
adjusted_weights = {}
for activity in self.getWorksheetActivities(worksheet):
score = self.getScore(student, activity)
category = activity.category
if score:
if category in weights and weights[category] is not None:
adjusted_weights[category] = weights[category]
total_percentage = 0
for key in adjusted_weights:
total_percentage += adjusted_weights[key]
if total_percentage:
for key in adjusted_weights:
adjusted_weights[key] /= total_percentage
totals = {}
average_totals = {}
average_counts = {}
for activity in self.getWorksheetActivities(worksheet):
score = self.getScore(student, activity)
if not score:
continue
minimum, maximum, value = getMinMaxValue(score)
if minimum is None:
continue
totals.setdefault(activity.category, Decimal(0))
totals[activity.category] += value
average_totals.setdefault(activity.category, Decimal(0))
average_totals[activity.category] += value
average_counts.setdefault(activity.category, Decimal(0))
average_counts[activity.category] += maximum
average = Decimal(0)
for category, value in average_totals.items():
if category in weights and weights[category] is not None:
average += ((value / average_counts[category]) *
adjusted_weights[category])
if not len(average_counts):
return 0, UNSCORED
else:
return sum(totals.values()), average * 100
# when not weighting categories, the default is to weight the
# evaluations by activities.
else:
total = 0
count = 0
for activity in self.getWorksheetActivities(worksheet):
score = self.getScore(student, activity)
if not score:
continue
minimum, maximum, value = getMinMaxValue(score)
if minimum is None:
continue
total += value
count += maximum
if count:
return total, Decimal(100 * total) / Decimal(count)
else:
return 0, UNSCORED
def getCurrentWorksheet(self, person):
section = self.section
worksheets = interfaces.IActivities(section)
current = worksheets.getCurrentWorksheet(person)
return current
def setCurrentWorksheet(self, person, worksheet):
section = self.section
worksheets = interfaces.IActivities(section)
worksheet = proxy.removeSecurityProxy(worksheet)
worksheets.setCurrentWorksheet(person, worksheet)
def getDueDateFilter(self, person):
person = proxy.removeSecurityProxy(person)
ann = annotation.interfaces.IAnnotations(person)
if DUE_DATE_FILTER_KEY not in ann:
return (False, '9')
return ann[DUE_DATE_FILTER_KEY]
def setDueDateFilter(self, person, flag, weeks):
person = proxy.removeSecurityProxy(person)
ann = annotation.interfaces.IAnnotations(person)
ann[DUE_DATE_FILTER_KEY] = (flag, weeks)
def getColumnPreferences(self, person):
person = proxy.removeSecurityProxy(person)
ann = annotation.interfaces.IAnnotations(person)
if COLUMN_PREFERENCES_KEY not in ann:
return PersistentDict()
return ann[COLUMN_PREFERENCES_KEY]
def setColumnPreferences(self, person, columnPreferences):
person = proxy.removeSecurityProxy(person)
ann = annotation.interfaces.IAnnotations(person)
ann[COLUMN_PREFERENCES_KEY] = PersistentDict(columnPreferences)
def getCurrentActivities(self, person):
worksheet = self.getCurrentWorksheet(person)
return self.getWorksheetActivities(worksheet)
def getCurrentEvaluationsForStudent(self, person, student):
"""See interfaces.IGradebook"""
self._checkStudent(student)
evaluations = requirement.interfaces.IEvaluations(student)
activities = self.getCurrentActivities(person)
for activity, evaluation in evaluations.items():
if (activity in activities and
evaluation.value is not UNSCORED):
yield activity, evaluation
def getEvaluationsForStudent(self, student):
"""See interfaces.IGradebook"""
self._checkStudent(student)
evaluations = requirement.interfaces.IEvaluations(student)
for activity, evaluation in evaluations.items():
if (activity in self.activities and
evaluation.value is not UNSCORED):
yield activity, evaluation
def getEvaluationsForActivity(self, activity):
"""See interfaces.IGradebook"""
self._checkActivity(activity)
for student in self.section.members:
evaluations = requirement.interfaces.IEvaluations(student)
if activity in evaluations:
yield student, evaluations[activity]
def getSortKey(self, person):
person = proxy.removeSecurityProxy(person)
ann = annotation.interfaces.IAnnotations(person)
if GRADEBOOK_SORTING_KEY not in ann:
ann[GRADEBOOK_SORTING_KEY] = PersistentDict()
section_id = hash(IKeyReference(self.section))
return ann[GRADEBOOK_SORTING_KEY].get(section_id, ('student', False))
def setSortKey(self, person, value):
person = proxy.removeSecurityProxy(person)
ann = annotation.interfaces.IAnnotations(person)
if GRADEBOOK_SORTING_KEY not in ann:
ann[GRADEBOOK_SORTING_KEY] = PersistentDict()
section_id = hash(IKeyReference(self.section))
ann[GRADEBOOK_SORTING_KEY][section_id] = value
class Gradebook(GradebookBase):
implements(interfaces.IGradebook)
adapts(interfaces.IActivityWorksheet)
def __init__(self, context):
super(Gradebook, self).__init__(context)
# To make URL creation happy
self.__name__ = 'gradebook'
class MyGrades(GradebookBase):
implements(interfaces.IMyGrades)
adapts(interfaces.IActivityWorksheet)
def __init__(self, context):
super(MyGrades, self).__init__(context)
# To make URL creation happy
self.__name__ = 'mygrades'
class StudentGradebook(object):
"""Adapter of student and gradebook used for grading one student at a
time"""
implements(interfaces.IStudentGradebook)
adapts(IBasicPerson, interfaces.IGradebook)
def __init__(self, student, gradebook):
self.student = student
self.gradebook = gradebook
activities = [(str(activity.__name__), activity)
for activity in gradebook.activities]
self.activities = dict(activities)
class StudentGradebookFormAdapter(object):
"""Adapter used by grade student view to interact with student
gradebook"""
implements(interfaces.IStudentGradebookForm)
adapts(interfaces.IStudentGradebook)
def __init__(self, context):
self.__dict__['context'] = context
def __setattr__(self, name, value):
gradebook = self.context.gradebook
student = self.context.student
activity = self.context.activities[name]
# XXX: hack to receive the evaluator from the form
evaluator = removeSecurityProxy(self.context).evaluator
try:
if value is None or value == '':
score = gradebook.getScore(student, activity)
if score:
gradebook.removeEvaluation(student, activity, evaluator=evaluator)
else:
score_value = activity.scoresystem.fromUnicode(value)
gradebook.evaluate(student, activity, score_value, evaluator)
except ScoreValidationError:
pass
def __getattr__(self, name):
activity = self.context.activities[name]
score = self.context.gradebook.getScore(self.context.student, activity)
if not score:
return ''
elif interfaces.ILinkedColumnActivity.providedBy(activity):
sourceObj = getSourceObj(activity.source)
if interfaces.IActivityWorksheet.providedBy(sourceObj):
return '%.1f' % score.value
return score.value
def getWorksheetSection(worksheet):
"""Adapt IActivityWorksheet to ISection."""
return worksheet.__parent__.__parent__
def getGradebookSection(gradebook):
"""Adapt IGradebook to ISection."""
return course.interfaces.ISection(gradebook.context)
def getMyGradesSection(gradebook):
"""Adapt IMyGrades to ISection."""
return course.interfaces.ISection(gradebook.context)
class GradebookEditorsCrowd(ConfigurableCrowd):
setting_key = 'administration_can_grade_students'
def contains(self, principal):
"""Return the value of the related setting (True or False)."""
return (AdministratorsCrowd(self.context).contains(principal) and
super(GradebookEditorsCrowd, self).contains(principal))
class GradebookReportTask(ReportTask):
implements(interfaces.IGradebookReportTask)
worksheet_intid = None
@property
def context(self):
int_ids = getUtility(IIntIds)
worksheet = int_ids.queryObject(self.worksheet_intid)
if worksheet is None:
return None
gradebook = interfaces.IGradebook(worksheet)
return gradebook
@context.setter
def context(self, value):
unproxied = removeSecurityProxy(value)
worksheet = unproxied.__parent__
int_ids = getUtility(IIntIds)
self.worksheet_intid = int_ids.getId(worksheet)
class TraversableXLSReportTask(XLSReportTask):
traverse_intid = None
traverse_name = None
@property
def context(self):
int_ids = getUtility(IIntIds)
target = int_ids.queryObject(self.traverse_intid)
if target is None:
return None
request = self.getCurrentRequest()
traverser = getMultiAdapter((target, request), Interface, self.traverse_name)
result = traverser.traverse(self.traverse_name)
return result
@context.setter
def context(self, value):
target, name = value
int_ids = getUtility(IIntIds)
self.traverse_intid = int_ids.getId(target)
self.traverse_name = name
|