app.py
10.6 KB
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
# python standard library
from contextlib import contextmanager # `with` statement in db sessions
import logging
from os import path, sys
from datetime import datetime
# user installed libraries
try:
import bcrypt
from sqlalchemy import create_engine
from sqlalchemy.orm import sessionmaker
import networkx as nx
import yaml
except ImportError:
logger.critical('Python package missing. See README.md for instructions.')
sys.exit(1)
# this project
from models import Student, Answer, Topic, StudentTopic
from knowledge import Knowledge
from questions import QFactory
from tools import load_yaml
# setup logger for this module
logger = logging.getLogger(__name__)
class LearnAppException(Exception):
pass
# ============================================================================
# LearnApp - application logic
# ============================================================================
class LearnApp(object):
def __init__(self, conffile='demo/demo.yaml'):
# online students
self.online = {}
# build dependency graph
self.build_dependency_graph(conffile)
# connect to database and check registered students
self.db_setup(self.depgraph.graph['database'])
# add topics from depgraph to the database
self.db_add_topics()
# ------------------------------------------------------------------------
# login
# ------------------------------------------------------------------------
def login(self, uid, try_pw):
with self.db_session() as s:
student = s.query(Student).filter(Student.id == uid).one_or_none()
if student is None:
logger.info(f'User "{uid}" does not exist.')
return False # student does not exist
hashedtry = bcrypt.hashpw(try_pw.encode('utf-8'), student.password)
if hashedtry != student.password:
logger.info(f'User "{uid}" wrong password.')
return False # wrong password
# success
tt = s.query(StudentTopic).filter(StudentTopic.student_id == uid)
state = {}
for t in tt:
state[t.topic_id] = {
'level': t.level,
'date': datetime.strptime(t.date, "%Y-%m-%d %H:%M:%S.%f"),
}
self.online[uid] = {
'name': student.name,
'number': student.id,
'state': Knowledge(self.depgraph, state=state, student=student.id)
}
logger.info(f'User "{uid}" logged in')
return True
# ------------------------------------------------------------------------
# logout
# ------------------------------------------------------------------------
def logout(self, uid):
state = self.online[uid]['state'].state # dict {node:level,...}
# save state to database
with self.db_session(autoflush=False) as s:
# update existing associations and remove from state dict
for a in s.query(StudentTopic).filter_by(student_id=uid):
if a.topic_id in state:
d = state.pop(a.topic_id)
a.level = d['level'] #state.pop(a.topic_id) # update
a.date = str(d['date'])
s.add(a)
# insert the remaining ones
u = s.query(Student).get(uid)
for n,d in state.items():
a = StudentTopic(level=d['level'], date=str(d['date']))
t = s.query(Topic).get(n)
if t is None: # create if topic doesn't exist yet
t = Topic(id=n)
a.topic = t
u.topics.append(a)
s.add(a)
del self.online[uid]
logger.info(f'User "{uid}" logged out')
# ------------------------------------------------------------------------
# change_password
# ------------------------------------------------------------------------
def change_password(self, uid, pw):
if not pw:
return False
with self.db_session() as s:
u = s.query(Student).get(uid)
u.password = bcrypt.hashpw(pw.encode('utf-8'), bcrypt.gensalt())
logger.info(f'User "{uid}" changed password')
return True
# ------------------------------------------------------------------------
def get_student_name(self, uid):
return self.online[uid].get('name', '')
# ------------------------------------------------------------------------
def get_student_state(self, uid):
return self.online[uid]['state'].get_knowledge_state()
# ------------------------------------------------------------------------
def get_student_progress(self, uid):
return self.online[uid]['state'].get_topic_progress()
# ------------------------------------------------------------------------
def get_student_question(self, uid):
return self.online[uid]['state'].get_current_question() # dict
# ------------------------------------------------------------------------
def get_title(self):
return self.depgraph.graph['title']
# ------------------------------------------------------------------------
def get_topic_name(self, ref):
return self.depgraph.node[ref]['name']
# ------------------------------------------------------------------------
def get_current_public_dir(self, uid):
topic = self.online[uid]['state'].get_current_topic()
p = self.depgraph.graph['path']
return path.join(p, topic, 'public')
# ------------------------------------------------------------------------
# check answer and if correct returns new question, otherwise returns None
# ------------------------------------------------------------------------
def check_answer(self, uid, answer):
knowledge = self.online[uid]['state']
current_question = knowledge.check_answer(answer)
if current_question is not None:
logger.debug('check_answer: saving answer to db ...')
with self.db_session() as s:
s.add(Answer(
ref=current_question['ref'],
grade=current_question['grade'],
starttime=str(current_question['start_time']),
finishtime=str(current_question['finish_time']),
student_id=uid))
s.commit()
return knowledge.new_question()
# ------------------------------------------------------------------------
# Given configuration file, loads YAML on that file and builds the graph.
# First, topics such as `computer/mips/exceptions` are added as nodes
# together with dependencies. Then, questions are loaded to a factory.
# ------------------------------------------------------------------------
def build_dependency_graph(self, config_file):
# Load configuration file to a dict
try:
with open(config_file, 'r') as f:
config = yaml.load(f)
except FileNotFoundError:
logger.critical(f'File not found: "{config_file}"')
raise LearnAppException
except yaml.scanner.ScannerError as err:
logger.critical(f'Parsing YAML file "{config_file}": {err}')
raise LearnAppException
else:
logger.info(f'Configuration file "{config_file}"')
# create graph
prefix = config.get('path', '.')
title = config.get('title', '')
database = config.get('database', 'students.db')
g = nx.DiGraph(path=prefix, title=title, database=database)
# iterate over topics and build graph
topics = config.get('topics', {})
for ref,attr in topics.items():
g.add_node(ref)
if isinstance(attr, dict):
g.node[ref]['name'] = attr.get('name', ref)
g.node[ref]['questions'] = attr.get('questions', [])
g.add_edges_from((d,ref) for d in attr.get('deps', []))
# iterate over topics and create question factories
logger.info('Loading:')
for ref in g.nodes_iter():
fullpath = path.expanduser(path.join(prefix, ref))
filename = path.join(fullpath, 'questions.yaml')
loaded_questions = load_yaml(filename, default=[])
# make dict from list of questions for easier selection
qdict = {q['ref']: q for q in loaded_questions}
# 'questions' not provided in configuration means load all
if not g.node[ref]['questions']:
g.node[ref]['questions'] = qdict.keys() #[q['ref'] for q in loaded_questions]
g.node[ref]['factory'] = []
for qref in g.node[ref]['questions']:
q = qdict[qref]
q['path'] = fullpath
g.node[ref]['factory'].append(QFactory(q))
logger.info(f' {len(g.node[ref]["factory"])} questions from "{ref}"')
self.depgraph = g
return g
# ------------------------------------------------------------------------
# Fill db table 'Topic' with topics from the graph if not already there.
# ------------------------------------------------------------------------
def db_add_topics(self):
with self.db_session() as s:
tt = [t[0] for t in s.query(Topic.id)] # db list of topics
nn = self.depgraph.nodes_iter() # topics in the graph
s.add_all([Topic(id=n) for n in nn if n not in tt])
# ------------------------------------------------------------------------
# setup and check database
# ------------------------------------------------------------------------
def db_setup(self, db):
engine = create_engine(f'sqlite:///{db}', echo=False)
self.Session = sessionmaker(bind=engine)
try:
with self.db_session() as s:
n = s.query(Student).count()
except Exception as e:
logger.critical(f'Database "{db}" not usable.')
sys.exit(1)
else:
logger.info(f'Database "{db}" has {n} students.')
# ------------------------------------------------------------------------
# helper to manage db sessions using the `with` statement, for example
# with self.db_session() as s: s.query(...)
# ------------------------------------------------------------------------
@contextmanager
def db_session(self, **kw):
session = self.Session(**kw)
try:
yield session
session.commit()
except Exception as e:
session.rollback()
raise e
finally:
session.close()