-
Notifications
You must be signed in to change notification settings - Fork 17
/
database.py
285 lines (247 loc) · 9.69 KB
/
database.py
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
'''
Database structure for NGShare
'''
# pylint: disable=invalid-name
# pylint: disable=too-few-public-methods
# pylint: disable=fixme
import base64
import datetime
import hashlib
from sqlalchemy import (Table, Column, INTEGER, TEXT, BLOB, TIMESTAMP, BOOLEAN,
ForeignKey)
from sqlalchemy.orm import relationship, backref
from sqlalchemy.ext.associationproxy import association_proxy
from sqlalchemy.ext.declarative import declarative_base
Base = declarative_base()
# Assignment -> Course (One to Many)
assignment_files_assoc_table = Table(
'assignment_files_assoc_table', Base.metadata,
Column('left_id', TEXT, ForeignKey('assignments._id'), primary_key=True),
Column('right_id', INTEGER, ForeignKey('files._id'), primary_key=True),
)
# Submission -> Course (One to Many)
submission_files_assoc_table = Table(
'submission_files_assoc_table', Base.metadata,
Column('left_id', TEXT, ForeignKey('submissions._id'), primary_key=True),
Column('right_id', INTEGER, ForeignKey('files._id'), primary_key=True),
)
# Submission (feedback) -> Course (One to Many)
feedback_files_assoc_table = Table(
'feedback_files_assoc_table', Base.metadata,
Column('left_id', TEXT, ForeignKey('submissions._id'), primary_key=True),
Column('right_id', INTEGER, ForeignKey('files._id'), primary_key=True),
)
class User(Base):
'A JupyterHub user; can be either instructor or student, or both'
__tablename__ = 'users'
id = Column(TEXT, primary_key=True)
teaching = association_proxy('inst_assoc', 'course',
creator=lambda course: InstructorAssociation(
course=course
), cascade_scalar_deletes=True)
taking = association_proxy('student_assoc', 'course',
creator=lambda course: StudentAssociation(
course=course
), cascade_scalar_deletes=True)
def __init__(self, name):
'Initialize with JupyterHub user name'
self.id = name
def __str__(self):
return '<User %s>' % self.id
def dump(self):
'Dump data to dict'
return {
'id': self.id,
}
def delete(self, db):
'Remove user and dependent data'
raise NotImplementedError('Currently users cannot be deleted')
@staticmethod
def from_jupyterhub_user(user_model, db):
'Import users from JupyterHub'
user_name = user_model['name']
user = db.query(User).filter(User.id == user_name).one_or_none()
if user is None:
user = User(user_name)
db.add(user)
db.commit()
return user
class Course(Base):
'An nbgrader course'
__tablename__ = 'courses'
# in case course name needs to be changed
_id = Column(INTEGER, primary_key=True)
id = Column(TEXT, unique=True)
instructors = association_proxy('inst_assoc', 'user',
creator=lambda user: InstructorAssociation(
user=user,
),
cascade_scalar_deletes=True)
students = association_proxy('student_assoc', 'user',
creator=lambda user: StudentAssociation(
user=user,
),
cascade_scalar_deletes=True)
assignments = relationship('Assignment', backref='course')
def dump(self):
'Dump data to dict'
return {
'_id': self._id,
'id': self.id,
}
def __init__(self, name, instructor):
'Initialize with course name and teacher'
self.id = name
self.instructors.append(instructor)
def __str__(self):
return '<Course %s>' % self.id
def delete(self, db):
'Remove course and dependent data'
raise NotImplementedError('Currently courses cannot be deleted')
class Assignment(Base):
'An nbgrader assignment'
__tablename__ = 'assignments'
# in case assignment name needs to be changed
_id = Column(INTEGER, primary_key=True)
id = Column(TEXT)
course_id = Column(INTEGER, ForeignKey('courses._id'))
submissions = relationship('Submission', backref='assignment')
files = relationship('File', secondary=assignment_files_assoc_table)
released = BOOLEAN()
due = Column(TIMESTAMP)
# TODO: timezoon
def __init__(self, name, course):
'Initialize with assignment name and course'
self.id = name
self.course = course
def __str__(self):
return '<Assignment %s>' % self.id
def dump(self):
'Dump data to dict'
return {
'_id': self._id,
'id': self.id,
'course_id': self.course_id,
'released': bool(self.released),
'due': self.due and self.due.strftime('%Y-%m-%d %H:%M:%S.%f %Z'),
}
def delete(self, db):
'Remove assignment and dependent data (files, submissions)'
for file_obj in self.files:
file_obj.delete(db)
for submission in self.submissions:
submission.delete(db)
db.delete(self)
class Submission(Base):
'A submission for an assignment'
__tablename__ = 'submissions'
_id = Column(INTEGER, primary_key=True)
assignment_id = Column(INTEGER, ForeignKey('assignments._id'))
timestamp = Column(TIMESTAMP)
student_id = Column(TEXT, ForeignKey('users.id'))
files = relationship('File', secondary=submission_files_assoc_table)
feedbacks = relationship('File', secondary=feedback_files_assoc_table)
student = relationship('User')
def __init__(self, student, assignment):
'Initialize with student and assignment'
self.timestamp = datetime.datetime.now()
self.student = student
self.assignment = assignment
def __str__(self):
return '<Submission %d>' % self._id
def dump(self):
'Dump data to dict'
return {
'_id': self._id,
'assignment_id': self.assignment_id,
'timestamp': self.timestamp and \
self.timestamp.strftime('%Y-%m-%d %H:%M:%S.%f %Z'),
'student_id': self.student_id,
}
def delete(self, db):
'Remove submission and dependent data (files, feedbacks)'
for file_obj in self.files:
file_obj.delete(db)
for file_obj in self.feedbacks:
file_obj.delete(db)
db.delete(self)
class File(Base):
'A File (for assignment, submission file, or submission feedback)'
__tablename__ = 'files'
_id = Column(INTEGER, primary_key=True)
filename = Column(TEXT)
contents = Column(BLOB)
checksum = Column(TEXT)
def __init__(self, filename, contents):
'Initialize with file name and content; auto-compute md5'
self.filename = filename
self.contents = contents
self.checksum = hashlib.md5(contents).hexdigest()
def __str__(self):
return '<File %s>' % self.filename
def dump(self):
'Dump data to dict'
return {
'_id': self._id,
'filename': self.filename,
'contents': base64.encodebytes(self.contents).decode(),
'checksum': self.checksum,
}
def delete(self, db):
'Remove file'
db.delete(self)
# Ref: https://stackoverflow.com/a/7524753
# Ref: https://stackoverflow.com/a/23734727
class InstructorAssociation(Base):
'Relationship between instructor and course, many to many, with extra data'
__tablename__ = 'instructor_assoc_table'
left_id = Column(TEXT, ForeignKey('users.id'), primary_key=True)
right_id = Column(TEXT, ForeignKey('courses.id'), primary_key=True)
first_name = Column(TEXT)
last_name = Column(TEXT)
email = Column(TEXT)
user = relationship(User, backref=backref(
'inst_assoc', cascade='save-update, merge, delete, delete-orphan'))
course = relationship(Course, backref=backref(
'inst_assoc', cascade='save-update, merge, delete, delete-orphan'))
@staticmethod
def find(db, instructor, course):
'Find association object from user and course'
return db.query(InstructorAssociation) \
.filter_by(user=instructor, course=course).one_or_none()
def dump(self):
'Dump data to dict'
return {
'left_id': self.left_id,
'right_id': self.right_id,
'first_name': self.first_name,
'last_name': self.last_name,
'email': self.email,
}
# Student -> Course (Many to Many)
class StudentAssociation(Base):
'Relationship between student and course, many to many, with extra data'
__tablename__ = 'student_assoc_table'
left_id = Column(TEXT, ForeignKey('users.id'), primary_key=True)
right_id = Column(TEXT, ForeignKey('courses.id'), primary_key=True)
first_name = Column(TEXT)
last_name = Column(TEXT)
email = Column(TEXT)
user = relationship(User, backref=backref(
'student_assoc', cascade='save-update, merge, delete, delete-orphan'))
course = relationship(Course, backref=backref(
'student_assoc', cascade='save-update, merge, delete, delete-orphan'))
@staticmethod
def find(db, student, course):
'Find association object from user and course'
return db.query(StudentAssociation) \
.filter_by(user=student, course=course).one_or_none()
def dump(self):
'Dump data to dict'
return {
'left_id': self.left_id,
'right_id': self.right_id,
'first_name': self.first_name,
'last_name': self.last_name,
'email': self.email,
}