add checks to:

- duplicate ref in the same file - options file in radio and checkbox questions load_yaml can raise more useful exceptions

add checks to:
- duplicate ref in the same file - options file in radio and checkbox questions load_yaml can raise more useful exceptions
Miguel Barão
1 parent b7b63323
Showing 4 changed files with 46 additions and 26 deletions Show diff stats
BUGS.md
aprendizations/learnapp.py
aprendizations/questions.py
aprendizations/tools.py
@@ -31,6 +31,7 @@
 # FIXED
+- mesma ref no mesmo ficheiro não é detectado.
 - enter nas respostas mostra json
 - apos clicar no botao responder, inactivar o input (importante quando o tempo de correcção é grande)
 - double click submits twice.
@@ -90,7 +90,6 @@ class LearnApp(object):
         for c, d in self.courses.items():
             for goal in d['goals']:
                 if goal not in self.deps.nodes():
-                    # logger.error(f'Goal "{goal}" of "{c}"" not in the graph')
                     raise LearnException(f'Goal "{goal}" from course "{c}" '
                                          ' does not exist')
@@ -409,14 +408,24 @@ class LearnApp(object):
             fullpath: str = path.join(topicpath, t['file'])
             logger.debug(f'  Loading {fullpath}')
-            questions: List[QDict] = load_yaml(fullpath, default=[])
+            # questions: List[QDict] = load_yaml(fullpath, default=[])
+            try:
+                questions: List[QDict] = load_yaml(fullpath)
+            except Exception:
+                raise LearnException(f'Failed to load "{fullpath}"')
             # update refs to include topic as prefix.
             # refs are required to be unique only within the file.
             # undefined are set to topic:n, where n is the question number
             # within the file
+            localrefs = set()  # refs in current file
             for i, q in enumerate(questions):
                 qref = q.get('ref', str(i))  # ref or number
+                if qref in localrefs:
+                    msg = f'Duplicate ref "{qref}" in "{topicpath}"'
+                    raise LearnException(msg)
+                localrefs.add(qref)
+
                 q['ref'] = f'{tref}:{qref}'
                 q['path'] = topicpath
                 q.setdefault('append_wrong', t['append_wrong'])
@@ -74,7 +74,14 @@ class QuestionRadio(Question):
     def __init__(self, q: QDict) -> None:
         super().__init__(q)
-        n = len(self['options'])
+        try:
+            n = len(self['options'])
+        except KeyError:
+            msg = f'Missing `options` in radio question. See {self["path"]}'
+            raise QuestionException(msg)
+        except TypeError:
+            msg = f'`options` must be a list. See {self["path"]}'
+            raise QuestionException(msg)
         self.set_defaults(QDict({
             'text': '',
@@ -185,7 +192,14 @@ class QuestionCheckbox(Question):
     def __init__(self, q: QDict) -> None:
         super().__init__(q)
-        n = len(self['options'])
+        try:
+            n = len(self['options'])
+        except KeyError:
+            msg = f'Missing `options` in radio question. See {self["path"]}'
+            raise QuestionException(msg)
+        except TypeError:
+            msg = f'`options` must be a list. See {self["path"]}'
+            raise QuestionException(msg)
         # set defaults if missing
         self.set_defaults(QDict({
@@ -111,14 +111,13 @@ class HighlightRenderer(mistune.Renderer):
     def table(self, header, body):
         return ('<table class="table table-sm"><thead class="thead-light">'
-               f'{header}</thead><tbody>{body}</tbody></table>')
+                f'{header}</thead><tbody>{body}</tbody></table>')
     def image(self, src, title, alt):
         alt = mistune.escape(alt, quote=True)
         title = mistune.escape(title or '', quote=True)
         return (f'<img src="/file/{src}" alt="{alt}" title="{title}"'
-                 'class="img-fluid">')
-                # class="img-fluid mx-auto d-block"
+                f'class="img-fluid">')  # class="img-fluid mx-auto d-block"
     # Pass math through unaltered - mathjax does the rendering in the browser
     def block_math(self, text):
@@ -150,25 +149,22 @@ def load_yaml(filename: str, default: Any = None) -&gt; Any:
     filename = path.expanduser(filename)
     try:
         f = open(filename, 'r', encoding='utf-8')
-    except FileNotFoundError:
-        logger.error(f'Cannot open "{filename}": not found')
-    except PermissionError:
-        logger.error(f'Cannot open "{filename}": no permission')
-    except OSError:
-        logger.error(f'Cannot open file "{filename}"')
-    else:
-        with f:
-            try:
-                default = yaml.safe_load(f)
-            except yaml.YAMLError as e:
-                if hasattr(e, 'problem_mark'):
-                    mark = e.problem_mark
-                    logger.error(f'File "{filename}" near line {mark.line+1}, '
-                                 f'column {mark.column+1}')
-                else:
-                    logger.error(f'File "{filename}"')
-    finally:
-        return default
+    except Exception as e:
+        logger.error(e)
+        if default is not None:
+            return default
+        else:
+            raise
+
+    with f:
+        try:
+            return yaml.safe_load(f)
+        except yaml.YAMLError as e:
+            logger.error(str(e).replace('\n', ' '))
+            if default is not None:
+                return default
+            else:
+                raise
 # ---------------------------------------------------------------------------
	@@ -31,6 +31,7 @@		@@ -31,6 +31,7 @@
31		31
32	# FIXED	32	# FIXED
33		33
		34	+- mesma ref no mesmo ficheiro não é detectado.
34	- enter nas respostas mostra json	35	- enter nas respostas mostra json
35	- apos clicar no botao responder, inactivar o input (importante quando o tempo de correcção é grande)	36	- apos clicar no botao responder, inactivar o input (importante quando o tempo de correcção é grande)
36	- double click submits twice.	37	- double click submits twice.
	@@ -74,7 +74,14 @@ class QuestionRadio(Question):		@@ -74,7 +74,14 @@ class QuestionRadio(Question):
74	def __init__(self, q: QDict) -> None:	74	def __init__(self, q: QDict) -> None:
75	super().__init__(q)	75	super().__init__(q)
76		76
77	- n = len(self['options'])	77	+ try:
		78	+ n = len(self['options'])
		79	+ except KeyError:
		80	+ msg = f'Missing `options` in radio question. See {self["path"]}'
		81	+ raise QuestionException(msg)
		82	+ except TypeError:
		83	+ msg = f'`options` must be a list. See {self["path"]}'
		84	+ raise QuestionException(msg)
78		85
79	self.set_defaults(QDict({	86	self.set_defaults(QDict({
80	'text': '',	87	'text': '',
	@@ -185,7 +192,14 @@ class QuestionCheckbox(Question):		@@ -185,7 +192,14 @@ class QuestionCheckbox(Question):
185	def __init__(self, q: QDict) -> None:	192	def __init__(self, q: QDict) -> None:
186	super().__init__(q)	193	super().__init__(q)
187		194
188	- n = len(self['options'])	195	+ try:
		196	+ n = len(self['options'])
		197	+ except KeyError:
		198	+ msg = f'Missing `options` in radio question. See {self["path"]}'
		199	+ raise QuestionException(msg)
		200	+ except TypeError:
		201	+ msg = f'`options` must be a list. See {self["path"]}'
		202	+ raise QuestionException(msg)
189		203
190	# set defaults if missing	204	# set defaults if missing
191	self.set_defaults(QDict({	205	self.set_defaults(QDict({