pygrader/storage.py

   1 # Copyright (C) 2012 W. Trevor King <wking@drexel.edu>
   2 #
   3 # This file is part of pygrader.
   4 #
   5 # pygrader is free software: you can redistribute it and/or modify it under the
   6 # terms of the GNU General Public License as published by the Free Software
   7 # Foundation, either version 3 of the License, or (at your option) any later
   8 # version.
   9 #
  10 # pygrader is distributed in the hope that it will be useful, but WITHOUT ANY
  11 # WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
  12 # A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
  13 #
  14 # You should have received a copy of the GNU General Public License along with
  15 # pygrader.  If not, see <http://www.gnu.org/licenses/>.
  16
  17 from __future__ import absolute_import
  18
  19 import calendar as _calendar
  20 import configparser as _configparser
  21 import email.utils as _email_utils
  22 import io as _io
  23 import os as _os
  24 import os.path as _os_path
  25 import re as _re
  26 import sys as _sys
  27 import time as _time
  28
  29 from . import LOG as _LOG
  30 from . import ENCODING as _ENCODING
  31 from .model.assignment import Assignment as _Assignment
  32 from .model.course import Course as _Course
  33 from .model.grade import Grade as _Grade
  34 from .model.person import Person as _Person
  35 from .todo import newer
  36
  37
  38 _DATE_REGEXP = _re.compile('^([^T]*)(T?)([^TZ+-.]*)([.]?[0-9]*)([+-][0-9:]*|Z?)$')
  39
  40
  41 def load_course(basedir):
  42     """Load a course directory.
  43
  44     >>> from pygrader.test.course import StubCourse
  45     >>> stub_course = StubCourse(load=False)
  46     >>> course = load_course(basedir=stub_course.basedir)
  47     >>> course.name
  48     'Physics 101'
  49     >>> course.assignments  # doctest: +ELLIPSIS
  50     [<pygrader.model.assignment.Assignment object at 0x...>, ...]
  51     >>> course.people  # doctest: +ELLIPSIS
  52     [<pygrader.model.person.Person object at 0x...>, ...]
  53     >>> course.grades
  54     []
  55     >>> print(course.robot)
  56     <Person Robot101>
  57     >>> stub_course.cleanup()
  58     """
  59     _LOG.debug('loading course from {}'.format(basedir))
  60     config = _configparser.ConfigParser()
  61     config.read([_os_path.join(basedir, 'course.conf')])
  62     name = config.get('course', 'name')
  63     names = {'robot': [config.get('course', 'robot').strip()]}
  64     for option in ['assignments', 'professors', 'assistants', 'students']:
  65         names[option] = [
  66         a.strip() for a in config.get('course', option).split(',')]
  67     assignments = []
  68     for assignment in names['assignments']:
  69         _LOG.debug('loading assignment {}'.format(assignment))
  70         assignments.append(load_assignment(
  71                 name=assignment, data=dict(config.items(assignment))))
  72     people = {}
  73     for group in ['robot', 'professors', 'assistants', 'students']:
  74         for person in names[group]:
  75             if person in people:
  76                 _LOG.debug('adding person {} to group {}'.format(
  77                         person, group))
  78                 people[person].groups.append(group)
  79             else:
  80                 _LOG.debug('loading person {} in group {}'.format(
  81                         person, group))
  82                 people[person] = load_person(
  83                     name=person, data=dict(config.items(person)))
  84                 people[person].groups = [group]
  85     people = people.values()
  86     robot = [p for p in people if 'robot' in p.groups][0]
  87     grades = list(load_grades(basedir, assignments, people))
  88     return _Course(
  89         name=name, assignments=assignments, people=people, grades=grades,
  90         robot=robot)
  91
  92 def parse_date(string):
  93     """Parse dates given using the W3C DTF profile of ISO 8601.
  94
  95     The following are legal formats::
  96
  97       YYYY (e.g. 2000)
  98       YYYY-MM (e.g. 2000-02)
  99       YYYY-MM-DD (e.g. 2000-02-12)
 100       YYYY-MM-DDThh:mmTZD (e.g. 2000-02-12T06:05+05:30)
 101       YYYY-MM-DDThh:mm:ssTZD (e.g. 2000-02-12T06:05:30+05:30)
 102       YYYY-MM-DDThh:mm:ss.sTZD (e.g. 2000-02-12T06:05:30.45+05:30)
 103
 104     Note that the TZD can be either the capital letter `Z` to indicate
 105     UTC time, a string in the format +hh:mm to indicate a local time
 106     expressed with a time zone hh hours and mm minutes ahead of UTC or
 107     -hh:mm to indicate a local time expressed with a time zone hh
 108     hours and mm minutes behind UTC.
 109
 110     >>> import calendar
 111     >>> import email.utils
 112     >>> import time
 113     >>> ref = calendar.timegm(time.strptime('2000', '%Y'))
 114     >>> y = parse_date('2000')
 115     >>> y - ref  # seconds between y and ref
 116     0
 117     >>> ym = parse_date('2000-02')
 118     >>> (ym - y)/(3600.*24)  # days between ym and y
 119     31.0
 120     >>> ymd = parse_date('2000-02-12')
 121     >>> (ymd - ym)/(3600.*24)  # days between ymd and ym
 122     11.0
 123     >>> ymdhm = parse_date('2000-02-12T06:05+05:30')
 124     >>> (ymdhm - ymd)/60.  # minutes between ymdhm and ymd
 125     35.0
 126     >>> (ymdhm - parse_date('2000-02-12T06:05Z'))/3600.
 127     -5.5
 128     >>> ymdhms = parse_date('2000-02-12T06:05:30+05:30')
 129     >>> ymdhms - ymdhm
 130     30
 131     >>> (ymdhms - parse_date('2000-02-12T06:05:30Z'))/3600.
 132     -5.5
 133     >>> ymdhms_ms = parse_date('2000-02-12T06:05:30.45+05:30')
 134     >>> ymdhms_ms - ymdhms  # doctest: +ELLIPSIS
 135     0.45000...
 136     >>> (ymdhms_ms - parse_date('2000-02-12T06:05:30.45Z'))/3600.
 137     -5.5
 138     >>> p = parse_date('1994-11-05T08:15:30-05:00')
 139     >>> email.utils.formatdate(p, localtime=True)
 140     'Sat, 05 Nov 1994 08:15:30 -0500'
 141     >>> p - parse_date('1994-11-05T13:15:30Z')
 142     0
 143     """
 144     m = _DATE_REGEXP.match(string)
 145     if not m:
 146         raise ValueError(string)
 147     date,t,time,ms,zone = m.groups()
 148     ret = None
 149     if t:
 150         date += 'T' + time
 151     error = None
 152     for fmt in ['%Y-%m-%dT%H:%M:%S',
 153                 '%Y-%m-%dT%H:%M',
 154                 '%Y-%m-%d',
 155                 '%Y-%m',
 156                 '%Y',
 157                 ]:
 158         try:
 159             ret = _time.strptime(date, fmt)
 160         except ValueError as e:
 161             error = e
 162         else:
 163             break
 164     if ret is None:
 165         raise error
 166     ret = list(ret)
 167     ret[-1] = 0  # don't use daylight savings time
 168     ret = _calendar.timegm(ret)
 169     if ms:
 170         ret += float(ms)
 171     if zone and zone != 'Z':
 172         sign = int(zone[1] + '1')
 173         hour,minute = map(int, zone.split(':', 1))
 174         offset = sign*(3600*hour + 60*minute)
 175         ret -= offset
 176     return ret
 177
 178 def parse_boolean(value):
 179     """Convert a boolean string into ``True`` or ``False``.
 180
 181     Supports the same values as ``RawConfigParser``
 182
 183     >>> parse_boolean('YES')
 184     True
 185     >>> parse_boolean('Yes')
 186     True
 187     >>> parse_boolean('tRuE')
 188     True
 189     >>> parse_boolean('False')
 190     False
 191     >>> parse_boolean('FALSE')
 192     False
 193     >>> parse_boolean('no')
 194     False
 195     >>> parse_boolean('none')
 196     Traceback (most recent call last):
 197       ...
 198     ValueError: Not a boolean: none
 199     >>> parse_boolean('')  # doctest: +NORMALIZE_WHITESPACE
 200     Traceback (most recent call last):
 201       ...
 202     ValueError: Not a boolean:
 203
 204     It passes through boolean inputs without modification (so you
 205     don't have to use strings for default values):
 206
 207     >>> parse_boolean({}.get('my-option', True))
 208     True
 209     >>> parse_boolean({}.get('my-option', False))
 210     False
 211     """
 212     if value in [True, False]:
 213         return value
 214     # Using an underscored method is hackish, but it should be fairly stable.
 215     p = _configparser.RawConfigParser()
 216     return p._convert_to_boolean(value)
 217
 218 def load_assignment(name, data):
 219     r"""Load an assignment from a ``dict``
 220
 221     >>> from email.utils import formatdate
 222     >>> a = load_assignment(
 223     ...     name='Attendance 1',
 224     ...     data={'points': '1',
 225     ...           'weight': '0.1/2',
 226     ...           'due': '2011-10-04T00:00-04:00',
 227     ...           'submittable': 'yes',
 228     ...           })
 229     >>> print(('{0.name} (points: {0.points}, weight: {0.weight}, '
 230     ...        'due: {0.due}, submittable: {0.submittable})').format(a))
 231     Attendance 1 (points: 1, weight: 0.05, due: 1317700800, submittable: True)
 232     >>> print(formatdate(a.due, localtime=True))
 233     Tue, 04 Oct 2011 00:00:00 -0400
 234     """
 235     points = int(data['points'])
 236     wterms = data['weight'].split('/')
 237     if len(wterms) == 1:
 238         weight = float(wterms[0])
 239     else:
 240         assert len(wterms) == 2, wterms
 241         weight = float(wterms[0])/float(wterms[1])
 242     due = parse_date(data['due'])
 243     submittable = parse_boolean(data.get('submittable', False))
 244     return _Assignment(
 245         name=name, points=points, weight=weight, due=due,
 246         submittable=submittable)
 247
 248 def load_person(name, data={}):
 249     r"""Load a person from a ``dict``
 250
 251     >>> from io import StringIO
 252     >>> stream = StringIO('''#comment line
 253     ... Tom Bombadil <tbomb@oldforest.net>  # post address comment
 254     ... Tom Bombadil <yellow.boots@oldforest.net>
 255     ... Goldberry <gb@oldforest.net>
 256     ... ''')
 257
 258     >>> p = load_person(
 259     ...     name='Gandalf',
 260     ...     data={'nickname': 'G-Man',
 261     ...           'emails': 'g@grey.edu, g@greyhavens.net',
 262     ...           'pgp-key': '0x0123456789ABCDEF',
 263     ...           })
 264     >>> print('{0.name}: {0.emails} | {0.pgp_key}'.format(p))
 265     Gandalf: ['g@grey.edu', 'g@greyhavens.net'] | 0x0123456789ABCDEF
 266     >>> p = load_person(name='Gandalf')
 267     >>> print('{0.name}: {0.emails} | {0.pgp_key}'.format(p))
 268     Gandalf: None | None
 269     """
 270     kwargs = {}
 271     emails = [x.strip() for x in data.get('emails', '').split(',')]
 272     emails = list(filter(bool, emails))  # remove blank emails
 273     if emails:
 274         kwargs['emails'] = emails
 275     nickname = data.get('nickname', None)
 276     if nickname:
 277         kwargs['aliases'] = [nickname]
 278     pgp_key = data.get('pgp-key', None)
 279     if pgp_key:
 280         kwargs['pgp_key'] = pgp_key
 281     return _Person(name=name, **kwargs)
 282
 283 def load_grades(basedir, assignments, people):
 284     for assignment in assignments:
 285         for person in people:
 286             _LOG.debug('loading {} grade for {}'.format(assignment, person))
 287             path = assignment_path(basedir, assignment, person)
 288             gpath = _os_path.join(path, 'grade')
 289             try:
 290                 g = _load_grade(_io.open(gpath, 'r', encoding=_ENCODING),
 291                                 assignment, person)
 292             except IOError:
 293                 continue
 294             #g.late = _os.stat(gpath).st_mtime > assignment.due
 295             g.late = _os_path.exists(_os_path.join(path, 'late'))
 296             npath = _os_path.join(path, 'notified')
 297             if _os_path.exists(npath):
 298                 g.notified = newer(npath, gpath)
 299             else:
 300                 g.notified = False
 301             yield g
 302
 303 def _load_grade(stream, assignment, person):
 304     try:
 305         points = float(stream.readline())
 306     except ValueError:
 307         _sys.stderr.write('failure reading {}, {}\n'.format(
 308                 assignment.name, person.name))
 309         raise
 310     comment = stream.read().strip() or None
 311     return _Grade(
 312         student=person, assignment=assignment, points=points, comment=comment)
 313
 314 def assignment_path(basedir, assignment, person):
 315     return _os_path.join(basedir,
 316                   _filesystem_name(person.name),
 317                   _filesystem_name(assignment.name))
 318
 319 def _filesystem_name(name):
 320     for a,b in [(' ', '_'), ('.', ''), ("'", ''), ('"', '')]:
 321         name = name.replace(a, b)
 322     return name
 323
 324 def set_notified(basedir, grade):
 325     """Mark `grade.student` as notified about `grade`
 326     """
 327     path = assignment_path(
 328         basedir=basedir, assignment=grade.assignment, person=grade.student)
 329     npath = _os_path.join(path, 'notified')
 330     _touch(npath)
 331
 332 def set_late(basedir, assignment, person):
 333     path = assignment_path(
 334         basedir=basedir, assignment=assignment, person=person)
 335     Lpath = _os_path.join(path, 'late')
 336     _touch(Lpath)
 337
 338 def _touch(path):
 339     """Touch a file (`path` is created if it doesn't already exist)
 340
 341     Also updates the access and modification times to the current
 342     time.
 343
 344     >>> from os import listdir, rmdir, unlink
 345     >>> from os.path import join
 346     >>> from tempfile import mkdtemp
 347     >>> d = mkdtemp(prefix='pygrader')
 348     >>> listdir(d)
 349     []
 350     >>> p = join(d, 'touched')
 351     >>> _touch(p)
 352     >>> listdir(d)
 353     ['touched']
 354     >>> _touch(p)
 355     >>> unlink(p)
 356     >>> rmdir(d)
 357     """
 358     with open(path, 'a') as f:
 359         pass
 360     _os.utime(path, None)
 361
 362 def initialize(basedir, course, dry_run=False, **kwargs):
 363     """Stub out the directory tree based on the course configuration.
 364     """
 365     for person in course.people:
 366         for assignment in course.assignments:
 367             path = assignment_path(basedir, assignment, person)
 368             if dry_run:  # we'll need to guess if mkdirs would work
 369                 if not _os_path.exists(path):
 370                     _LOG.debug('creating {}'.format(path))
 371             else:
 372                 try:
 373                     _os.makedirs(path)
 374                 except OSError:
 375                     continue
 376                 else:
 377                     _LOG.debug('creating {}'.format(path))