- add_from_files does not immediately abort on error

- pretty errors and warnings on startup - removed option 'save_answers' from test configuration. It is now automatically defined depending on the existence of a 'answers_dir' option. - several fixes in managing paths.

- add_from_files does not immediately abort on error
- pretty errors and warnings on startup - removed option 'save_answers' from test configuration. It is now automatically defined depending on the existence of a 'answers_dir' option. - several fixes in managing paths.
Miguel Barão
1 parent df573134
Showing 4 changed files with 82 additions and 58 deletions Show diff stats
config/server.conf
questions.py
serve.py
test.py
@@ -23,8 +23,9 @@ server.socket_port = 8080
 log.screen = False
 # add path to the log files here. empty strings disable logging
-log.error_file = '/Users/mjsb/Library/Logs/Perguntations/errors.log'
-log.access_file = '/Users/mjsb/Library/Logs/Perguntations/access.log'
+log.error_file = '/Users/mjsb/Work/Projects/perguntations/logs/errors.log'
+log.access_file = ''
+; log.access_file = '/Users/mjsb/Library/Logs/Perguntations/access.log'
 # DO NOT DISABLE SESSIONS!
 tools.sessions.on = True
@@ -9,7 +9,6 @@ import os.path
 # Example usage:
 #
 #   pool = QuestionPool()
-#   pool.add_from_file('filename.yaml')
 #   pool.add_from_files(['file1.yaml', 'file1.yaml'])
 #
 #   test = []
@@ -22,29 +21,18 @@ import os.path
 # ===========================================================================
 class QuestionsPool(dict):
     '''This class contains base questions read from files, but which are
-    not ready yet. They have to be instantiated separatly for each student.'''
+    not ready yet. They have to be instantiated for each student.'''
     #------------------------------------------------------------------------
-    def add_from_file(self, filename, path='.'):
-        path_file = os.path.normpath(os.path.join(path, filename))
-        try:
-            with open(path_file, 'r') as f:
-                questions = yaml.load(f)
-        except(FileNotFoundError):
-            print('  * Questions file "{0}" not found. Aborting...'.format(path_file))
-            sys.exit(1)
-        except(yaml.parser.ParserError):
-            print('  * Error in questions file "{0}". Aborting...'.format(filename))
-            sys.exit(1)
-
-        # add defaults if missing from sources
+    def add(self, questions, filename, path):
+        # add some defaults if missing from sources
         for i, q in enumerate(questions):
             if not isinstance(q, dict):
-                print('  * question with index {0} in file {1} is not a dict. Ignoring...'.format(i, filename))
+                print('[ WARNG ]  Question with index {0} in file {1} is not a dict. Ignoring...'.format(i, filename))
                 continue
             if q['ref'] in self:
-                print('  * question "{0}" in file "{1}" already exists in file "{2}".'.format(q['ref'], filename, self[q['ref']]['filename']))
+                print('[ ERROR ]  Duplicate question "{0}" in files "{1}" and "{2}".'.format(q['ref'], filename, self[q['ref']]['filename']))
                 sys.exit(1)
             # filename and index (number in the file, 0 based)
@@ -67,7 +55,16 @@ class QuestionsPool(dict):
     #------------------------------------------------------------------------
     def add_from_files(self, files, path='.'):
         for filename in files:
-            self.add_from_file(filename, path)
+            try:
+                with open(os.path.normpath(os.path.join(path, filename)), 'r') as f:
+                    questions = yaml.load(f)
+            except(FileNotFoundError):
+                print('[ ERROR ]  Questions file "{0}" not found.'.format(filename))
+                continue
+            except(yaml.parser.ParserError):
+                print('[ ERROR ] Error loading questions in YAML file "{0}".'.format(filename))
+                continue
+            self.add(questions, filename, path)
 #============================================================================
@@ -103,14 +100,14 @@ def create_question(q):
     try:
         questiontype = types[q['type']]
     except KeyError:
-        print('  * unsupported question type "{0}" in "{1}:{2}".'.format(q['type'], q['filename'], q['ref']))
+        print('[ ERROR ]  Unsupported question type "{0}" in "{1}:{2}".'.format(q['type'], q['filename'], q['ref']))
         questiontype = Question
     # create question instance and return
     try:
         qinstance = questiontype(q)
     except:
-        print('  * Error creating question "{0}" from file "{1}".'.format(q['ref'], q['filename']))
+        print('[ ERROR ]  Creating question "{0}" from file "{1}".'.format(q['ref'], q['filename']))
     return qinstance
@@ -126,7 +123,7 @@ def question_generator(q):
     try:
         p = subprocess.Popen([script], stdout=subprocess.PIPE, stdin=subprocess.PIPE, stderr=subprocess.STDOUT)
     except FileNotFoundError:
-        print('  * Script "{0}" of question "{1}" in file "{2}" could not be found'.format(script, q['ref'], q['filename']))
+        print('[ ERROR ]  Script "{0}" of question "{2}:{1}" not found'.format(script, q['ref'], q['filename']))
         sys.exit(1)
     try:
@@ -11,7 +11,7 @@ from os import path
 # path where this file is located
 SERVER_PATH = path.dirname(path.realpath(__file__))
-TEMPLATES_DIR = SERVER_PATH + '/templates'
+TEMPLATES_DIR = path.join(SERVER_PATH, 'templates')
 # my code
 from myauth import AuthController, require
@@ -187,7 +187,7 @@ if __name__ == &#39;__main__&#39;:
     # --- controller
     root = Root(testconf)
-    # --- Mount and run server.
+    # --- Mount and run server
     cherrypy.config.update({'tools.staticdir.root': SERVER_PATH})
     cherrypy.quickstart(root, '/', config=arg.server)
     cherrypy.log('Terminated OK ------------------------', 'APPLICATION')
-import os, sys
+import os, sys, fnmatch
 import random
-import yaml
-import json
+import yaml, json
 import sqlite3
 from datetime import datetime
@@ -13,16 +12,23 @@ import database
 # ===========================================================================
 def read_configuration(filename, debug=False, show_points=False, show_hints=False, practice=False, save_answers=False, show_ref=False):
     # FIXME validar se ficheiros e directorios existem???
-    if not os.path.isfile(filename):
-        print('  * Cannot find file "%s"' % filename)
-        sys.exit(1)
     try:
-        with open(filename, 'r') as f:
-            test = yaml.load(f)
-    except:
-        print('  * Error reading yaml file "{0}".'.format(filename))
-        raise
+        f = open(filename, 'r')
+    except IOError:
+        print('[ ERROR ]  Cannot open YAML file "%s"' % filename)
+        sys.exit(1)
+    else:
+        with f:
+            try:
+                test = yaml.load(f)
+            except yaml.YAMLError as exc:
+                mark = exc.problem_mark
+                print('[ ERROR ]  In YAML file "{0}" near line {1}, column {2}.'.format(filename,mark.line,mark.column+1))
+                sys.exit(1)
+    # -- test yaml was loaded ok
+
+    errors = 0
     # defaults:
     test['ref'] = str(test.get('ref', filename))
@@ -32,34 +38,51 @@ def read_configuration(filename, debug=False, show_points=False, show_hints=Fals
     test['practice'] = bool(test.get('practice', practice))
     test['debug'] = bool(test.get('debug', debug))
     test['show_ref'] = bool(test.get('show_ref', show_ref))
-    test['path'] = str(test.get('path', '.'))  # questions dir  FIXME use os.path
-    # FIXME check that the directory exists
-    if not os.path.exists(test['path']):
-        print('  * Questions path "{0}" does not exist. Fix it in "{1}".'.format(test['path'], filename))
-        sys.exit(1)
-    test['save_answers'] = bool(test.get('save_answers', save_answers))
-    if test['save_answers']:
-        if 'answers_dir' not in test:
-            raise exception('Missing "answers_dir" in the test configuration.')
+
+    # this is the base directory where questions are stored
+    test['questions_dir'] = os.path.normpath(os.path.expanduser(str(test.get('questions_dir', os.path.curdir))))
+    if not os.path.exists(test['questions_dir']):
+        print('[ ERROR ]  Questions directory "{0}" does not exist.\n           Fix the "questions_dir" key in the configuration file "{1}".'.format(test['questions_dir'], filename))
+        errors += 1
+
+    # where to put the students answers (optional)
+    if 'answers_dir' not in test:
+        print('[ WARNG ]  Missing "answers_dir" in the test configuration file "{0}".\n           Saving answers is disabled'.format(filename))
+        test['save_answers'] = False
+    else:
+        test['answers_dir'] = os.path.normpath(os.path.expanduser(str(test['answers_dir'])))
         if not os.path.isdir(test['answers_dir']):
-            print('  * Directory "%s" does not exist. Creating...' % test['answers_dir'])
-            os.mkdir(test['answers_dir'])
+            print('[ ERROR ]  Directory "{0}" does not exist.'.format(test['answers_dir']))
+            errors += 1
+        test['save_answers'] = True
+    # database with login credentials and grades
     if 'database' not in test:
-        print('  * Missing database in the test configuration.')
+        print('[ ERROR ]  Missing "database" key in the test configuration "{0}".'.format(filename))
+        errors += 1
+    else:
+        test['database'] = os.path.normpath(os.path.expanduser(str(test['database'])))
+        if not os.path.exists(test['database']):
+            print('[ ERROR ]  Database "{0}" not found.'.format(test['database']))
+            errors += 1
+
+    if errors > 0:
+        print('{0} error(s) found. Aborting!'.format(errors))
         sys.exit(1)
-    if not os.path.exists(test['database']):
-        print('  * Database "{0}" not found.'.format(test['database']))
-        sys.exit(1)
-
-    if isinstance(test['files'], str):
-        test['files'] = [test['files']]
+    # deal with questions files
+    if 'files' not in test:
+        # no files were defined = load all from questions_dir
+        test['files'] = fnmatch.filter(os.listdir(test['questions_dir']), '*.yaml')
+        print('[ WARNG ]  All YAML files from directory were loaded. Might not be such a good idea...')
+    else:
+        # only one file
+        if isinstance(test['files'], str):
+            test['files'] = [test['files']]
     # replace ref,points by actual questions from pool
     pool = questions.QuestionsPool()
-    pool.add_from_files(files=
-        test['files'], path=test['path'])
+    pool.add_from_files(files=test['files'], path=test['questions_dir'])
     for i, q in enumerate(test['questions']):
         # each question is a list of alternative versions, even if the list
@@ -93,7 +116,7 @@ def read_configuration(filename, debug=False, show_points=False, show_hints=Fals
                 try:
                     qq = pool[r]
                 except KeyError:
-                    print('  * question "{0}" in test "{1}" not found in the pool. Ignoring...'.format(r, test['ref']))
+                    print('[ WARNG ]  Question reference "{0}" of test "{1}" not found. Skipping...'.format(r, test['ref']))
                     continue
                 qq['points'] = p
                 l.append(qq)
@@ -111,7 +134,10 @@ class Test(dict):
         qlist = []
         for i, qq in enumerate(self['questions']):
-            q = random.choice(qq)  # select from alternative versions
+            try:
+                q = random.choice(qq)  # select from alternative versions
+            except IndexError:
+                print(qq)  # FIXME
             qlist.append(questions.create_question(q))  # create instance
         self['questions'] = qlist
         self['start_time'] = datetime.now()
	@@ -11,7 +11,7 @@ from os import path		@@ -11,7 +11,7 @@ from os import path
11		11
12	# path where this file is located	12	# path where this file is located
13	SERVER_PATH = path.dirname(path.realpath(__file__))	13	SERVER_PATH = path.dirname(path.realpath(__file__))
14	-TEMPLATES_DIR = SERVER_PATH + '/templates'	14	+TEMPLATES_DIR = path.join(SERVER_PATH, 'templates')
15		15
16	# my code	16	# my code
17	from myauth import AuthController, require	17	from myauth import AuthController, require
	@@ -187,7 +187,7 @@ if __name__ == '__main__':		@@ -187,7 +187,7 @@ if __name__ == '__main__':
187	# --- controller	187	# --- controller
188	root = Root(testconf)	188	root = Root(testconf)
189		189
190	- # --- Mount and run server.	190	+ # --- Mount and run server
191	cherrypy.config.update({'tools.staticdir.root': SERVER_PATH})	191	cherrypy.config.update({'tools.staticdir.root': SERVER_PATH})
192	cherrypy.quickstart(root, '/', config=arg.server)	192	cherrypy.quickstart(root, '/', config=arg.server)
193	cherrypy.log('Terminated OK ------------------------', 'APPLICATION')	193	cherrypy.log('Terminated OK ------------------------', 'APPLICATION')