- cleanup app.py a little.

Miguel Barão
1 parent 834adb07
Showing 5 changed files with 61 additions and 63 deletions Show diff stats
app.py
initdb.py
knowledge.py
serve.py
tools.py
@@ -25,6 +25,10 @@ from tools import load_yaml
 # setup logger for this module
 logger = logging.getLogger(__name__)
+
+class LearnAppException(Exception):
+    pass
+
 # ============================================================================
 # LearnApp - application logic
 # ============================================================================
@@ -37,19 +41,20 @@ class LearnApp(object):
         self.build_dependency_graph(conffile)
         # connect to database and check registered students
-        self.db_setup(self.depgraph.graph['database'])    # FIXME
+        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()
-
+            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 or already loggeg in
+                return False    # student does not exist
             hashedtry = bcrypt.hashpw(try_pw.encode('utf-8'), student.password)
             if hashedtry != student.password:
@@ -76,6 +81,7 @@ class LearnApp(object):
     # ------------------------------------------------------------------------
     # logout
+    # ------------------------------------------------------------------------
     def logout(self, uid):
         state = self.online[uid]['state'].state  # dict {node:level,...}
@@ -105,6 +111,8 @@ class LearnApp(object):
         logger.info(f'User "{uid}" logged out')
     # ------------------------------------------------------------------------
+    # change_password
+    # ------------------------------------------------------------------------
     def change_password(self, uid, pw):
         if not pw:
             return False
@@ -165,21 +173,26 @@ class LearnApp(object):
         return knowledge.new_question()
     # ------------------------------------------------------------------------
-    # Receives a set of topics (strings like "math/algebra"),
-    # and recursively adds dependencies to the dependency graph
+    # 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
+        # Load configuration file to a dict
         try:
             with open(config_file, 'r') as f:
-                logger.info(f'Configuration file "{config_file}"')
                 config = yaml.load(f)
-        except FileNotFoundError as e:
-            logger.error(f'File not found: "{config_file}"')
-            sys.exit(1)
-        # config file parsed
+        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')
@@ -194,49 +207,35 @@ class LearnApp(object):
                 g.node[ref]['questions'] = attr.get('questions', [])
                 g.add_edges_from((d,ref) for d in attr.get('deps', []))
-            elif isinstance(attr, list):
-                # if prop is a list, we assume it's just a list of dependencies
-                g.add_edges_from((d,ref) for d in attr)
-
-            elif isinstance(attr, str):     # FIXME is this really useful??
-                g.node[ref]['name'] = attr
-
         # iterate over topics and create question factories
         logger.info('Loading:')
         for ref in g.nodes_iter():
-            g.node[ref].setdefault('name', ref)
-            prefix_ref = path.join(prefix, ref)
-            fullpath = path.expanduser(prefix_ref)
-            if path.isdir(fullpath):
-                filename = path.join(fullpath, "questions.yaml")
-            else:
-                logger.error(f'Cant find directory "{prefix_ref}", ignored...')
-                continue
-
-            if path.isfile(filename):
-                loaded_questions = load_yaml(filename, default=[])
-
-                # if 'questions' is not provided in configuration, load all
-                if not g.node[ref]['questions']:
-                    g.node[ref]['questions'] = [q['ref'] for q in loaded_questions]
-
-
-                # FIXME nao permite perguntas repetidas. iterar questions da configuracao em vez das do ficheiro.
-                g.node[ref]['factory'] = []
-                for q in loaded_questions:
-                    if q['ref'] in g.node[ref]['questions']:
-                        q['path'] = fullpath
-                        g.node[ref]['factory'].append(QFactory(q))
-                logger.info(f'  {len(g.node[ref]["factory"])} questions from "{ref}"')
-
-            else:
-                g.node[ref]['factory'] = []
-                logger.error(f'Cant load "{filename}"')
+            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
@@ -245,8 +244,8 @@ class LearnApp(object):
     # ------------------------------------------------------------------------
     # setup and check database
+    # ------------------------------------------------------------------------
     def db_setup(self, db):
-        logger.debug(f'LearnApp.db_setup("{db}")')
         engine = create_engine(f'sqlite:///{db}', echo=False)
         self.Session = sessionmaker(bind=engine)
         try:
@@ -256,11 +255,12 @@ class LearnApp(object):
             logger.critical(f'Database "{db}" not usable.')
             sys.exit(1)
         else:
-            logger.info(f'Database has {n} students registered.')
+            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)
@@ -31,6 +31,9 @@ engine = create_engine(f&#39;sqlite:///{args.db}&#39;, echo=False)
 Base.metadata.create_all(engine)  # Criate schema if needed
 Session = sessionmaker(bind=engine)
+# add administrator
+students = {'0': 'Professor'}
+
 if args.csvfile:
     # add students from csv file if available
     try:
@@ -38,12 +41,11 @@ if args.csvfile:
     except EnvironmentError:
         print(f'Error: CSV file "{args.csvfile}" not found.')
         exit(1)
-
-    students = {s['N.º']: fix(s['Nome']) for s in csvreader}
+    students.update({s['N.º']: fix(s['Nome']) for s in csvreader})
 elif args.demo:
     # add a few fake students
-    students = {
+    students.update({
         '1915': 'Alan Turing',
         '1938': 'Donald Knuth',
         '1815': 'Ada Lovelace',
@@ -51,13 +53,10 @@ elif args.demo:
         '1955': 'Tim Burners-Lee',
         '1916': 'Claude Shannon',
         '1903': 'John von Neumann',
-    }
-
-# add administrator
-students['0'] = 'Professor'
+    })
+print(f'Generating {len(students)} bcrypt password hashes. This will take some time...')
-print('Generating bcrypt password hashes takes time. Please be patient.')
 try:
     # --- start db session ---
     session = Session()
@@ -30,7 +30,7 @@ class Knowledge(object):
     # ------------------------------------------------------------------------
     def new_topic(self, topic=None):
         if topic is None:
-            # select the first topic that has level < 0.9
+            # select the first topic that has level < 0.8
             for topic in self.topic_sequence:
                 if topic not in self.state or self.state[topic]['level'] < 0.8:
                     break
@@ -234,15 +234,14 @@ def main():
     http_server.listen(8443)
     # --- start webserver
+    logging.info('Webserver running...')
     try:
-        logging.info('Webserver running...')
         tornado.ioloop.IOLoop.current().start()
-
         # running...
-
     except KeyboardInterrupt:
         tornado.ioloop.IOLoop.current().stop()
-        logging.info('Webserver stopped.')
+    finally:
+        logging.critical('Webserver stopped.')
 # ----------------------------------------------------------------------------
 if __name__ == "__main__":
@@ -14,7 +14,7 @@ def load_yaml(filename, default=None):
     try:
         f = open(filename, 'r', encoding='utf-8')
     except IOError:
-        logger.error('Can\'t open file "{}"'.format(filename))
+        logger.error(f'Can\'t open file "{filename}"')
         return default
     else:
         with f:
	@@ -30,7 +30,7 @@ class Knowledge(object):		@@ -30,7 +30,7 @@ class Knowledge(object):
30	# ------------------------------------------------------------------------	30	# ------------------------------------------------------------------------
31	def new_topic(self, topic=None):	31	def new_topic(self, topic=None):
32	if topic is None:	32	if topic is None:
33	- # select the first topic that has level < 0.9	33	+ # select the first topic that has level < 0.8
34	for topic in self.topic_sequence:	34	for topic in self.topic_sequence:
35	if topic not in self.state or self.state[topic]['level'] < 0.8:	35	if topic not in self.state or self.state[topic]['level'] < 0.8:
36	break	36	break
	@@ -14,7 +14,7 @@ def load_yaml(filename, default=None):		@@ -14,7 +14,7 @@ def load_yaml(filename, default=None):
14	try:	14	try:
15	f = open(filename, 'r', encoding='utf-8')	15	f = open(filename, 'r', encoding='utf-8')
16	except IOError:	16	except IOError:
17	- logger.error('Can\'t open file "{}"'.format(filename))	17	+ logger.error(f'Can\'t open file "{filename}"')
18	return default	18	return default
19	else:	19	else:
20	with f:	20	with f: