Moved question factory to questions.yaml

Moved menu item "topicos" to menu bar.

Moved question factory to questions.yaml
Moved menu item "topicos" to menu bar.
Miguel Barao
1 parent ab185529
Showing 6 changed files with 189 additions and 201 deletions Show diff stats
aprendizations/factory.py
aprendizations/learnapp.py
aprendizations/questions.py
aprendizations/serve.py
aprendizations/templates/maintopics-table.html
aprendizations/templates/topic.html
@@ -1,99 +0,0 @@
-# QFactory is a class that can generate question instances, e.g. by shuffling
-# options, running a script to generate the question, etc.
-#
-# To generate an instance of a question we use the method generate() where
-# the argument is the reference of the question we wish to produce.
-#
-# Example:
-#
-#   # read question from file
-#   qdict = tools.load_yaml(filename)
-#   qfactory = QFactory(qdict)
-#   question = qfactory.generate()
-#
-#   # experiment answering one question and correct it
-#   question.updateAnswer('42')      # insert answer
-#   grade = question.correct()       # correct answer
-
-# An instance of an actual question is an object that inherits from Question()
-#
-# Question          - base class inherited by other classes
-# QuestionInformation - not a question, just a box with content
-# QuestionRadio     - single choice from a list of options
-# QuestionCheckbox  - multiple choice, equivalent to multiple true/false
-# QuestionText      - line of text compared to a list of acceptable answers
-# QuestionTextRegex - line of text matched against a regular expression
-# QuestionTextArea  - corrected by an external program
-# QuestionNumericInterval - line of text parsed as a float
-
-# base
-from os import path
-import logging
-
-# project
-from aprendizations.tools import run_script
-from aprendizations.questions import (QuestionInformation, QuestionRadio,
-                                      QuestionCheckbox, QuestionText,
-                                      QuestionTextRegex, QuestionTextArea,
-                                      QuestionNumericInterval,
-                                      QuestionException)
-
-# setup logger for this module
-logger = logging.getLogger(__name__)
-
-
-# ===========================================================================
-# Question Factory
-# ===========================================================================
-class QFactory(object):
-    # Depending on the type of question, a different question class will be
-    # instantiated. All these classes derive from the base class `Question`.
-    _types = {
-        'radio':            QuestionRadio,
-        'checkbox':         QuestionCheckbox,
-        'text':             QuestionText,
-        'text-regex':       QuestionTextRegex,
-        'numeric-interval': QuestionNumericInterval,
-        'textarea':         QuestionTextArea,
-        # -- informative panels --
-        'information':      QuestionInformation,
-        'warning':          QuestionInformation,
-        'alert':            QuestionInformation,
-        'success':          QuestionInformation,
-        }
-
-    def __init__(self, question_dict={}):
-        self.question = question_dict
-
-    # -----------------------------------------------------------------------
-    # Given a ref returns an instance of a descendent of Question(),
-    # i.e. a question object (radio, checkbox, ...).
-    # -----------------------------------------------------------------------
-    def generate(self):
-        logger.debug(f'Generating "{self.question["ref"]}"...')
-        # Shallow copy so that script generated questions will not replace
-        # the original generators
-        q = self.question.copy()
-
-        # If question is of generator type, an external program will be run
-        # which will print a valid question in yaml format to stdout. This
-        # output is then yaml parsed into a dictionary `q`.
-        if q['type'] == 'generator':
-            logger.debug(f' \\_ Running "{q["script"]}".')
-            q.setdefault('args', [])
-            q.setdefault('stdin', '')
-            script = path.join(q['path'], q['script'])
-            out = run_script(script=script, args=q['args'], stdin=q['stdin'])
-            q.update(out)
-
-        # Finally we create an instance of Question()
-        try:
-            qinstance = self._types[q['type']](q)  # instance matching class
-        except QuestionException as e:
-            logger.error(e)
-            raise e
-        except KeyError:
-            logger.error(f'Invalid type "{q["type"]}" in "{q["ref"]}"')
-            raise
-        else:
-            return qinstance
@@ -15,7 +15,7 @@ import networkx as nx
 # this project
 from aprendizations.models import Student, Answer, Topic, StudentTopic
 from aprendizations.knowledge import StudentKnowledge
-from aprendizations.factory import QFactory
+from aprendizations.questions import QFactory
 from aprendizations.tools import load_yaml
 # setup logger for this module
@@ -30,7 +30,7 @@ class Question(dict):
     def __init__(self, q):
         super().__init__(q)
-        # add these if missing
+        # add required keys if missing
         self.set_defaults({
             'title': '',
             'answer': None,
@@ -368,3 +368,81 @@ class QuestionInformation(Question):
     def correct(self):
         super().correct()
         self['grade'] = 1.0  # always "correct" but points should be zero!
+
+
+# ===========================================================================
+# QFactory is a class that can generate question instances, e.g. by shuffling
+# options, running a script to generate the question, etc.
+#
+# To generate an instance of a question we use the method generate() where
+# the argument is the reference of the question we wish to produce.
+# The generate() method returns a question instance of the correct class.
+#
+# Example:
+#
+#   # generate a question instance from a dictionary
+#   qdict = {
+#       'type': 'radio',
+#       'text': 'Choose one',
+#       'options': ['a', 'b']
+#       }
+#   qfactory = QFactory(qdict)
+#   question = qfactory.generate()
+#
+#   # answer one question and correct it
+#   question['answer'] = 42          # set answer
+#   question.correct()               # correct answer
+#   print(question['grade'])         # print grade
+# ===========================================================================
+class QFactory(object):
+    # Depending on the type of question, a different question class will be
+    # instantiated. All these classes derive from the base class `Question`.
+    _types = {
+        'radio':            QuestionRadio,
+        'checkbox':         QuestionCheckbox,
+        'text':             QuestionText,
+        'text-regex':       QuestionTextRegex,
+        'numeric-interval': QuestionNumericInterval,
+        'textarea':         QuestionTextArea,
+        # -- informative panels --
+        'information':      QuestionInformation,
+        'warning':          QuestionInformation,
+        'alert':            QuestionInformation,
+        'success':          QuestionInformation,
+        }
+
+    def __init__(self, question_dict={}):
+        self.question = question_dict
+
+    # -----------------------------------------------------------------------
+    # Given a ref returns an instance of a descendent of Question(),
+    # i.e. a question object (radio, checkbox, ...).
+    # -----------------------------------------------------------------------
+    def generate(self):
+        logger.debug(f'Generating "{self.question["ref"]}"...')
+        # Shallow copy so that script generated questions will not replace
+        # the original generators
+        q = self.question.copy()
+
+        # If question is of generator type, an external program will be run
+        # which will print a valid question in yaml format to stdout. This
+        # output is then yaml parsed into a dictionary `q`.
+        if q['type'] == 'generator':
+            logger.debug(f' \\_ Running "{q["script"]}".')
+            q.setdefault('args', [])
+            q.setdefault('stdin', '')
+            script = path.join(q['path'], q['script'])
+            out = run_script(script=script, args=q['args'], stdin=q['stdin'])
+            q.update(out)
+
+        # Finally we create an instance of Question()
+        try:
+            qinstance = self._types[q['type']](q)  # instance matching class
+        except QuestionException as e:
+            logger.error(e)
+            raise e
+        except KeyError:
+            logger.error(f'Invalid type "{q["type"]}" in "{q["ref"]}"')
+            raise
+        else:
+            return qinstance
@@ -454,20 +454,21 @@ def main():
     logging.info('====================== Start Logging ======================')
     # --- start application
-    logging.info('Starting App')
+    logging.info('Starting App...')
     try:
-        learnapp = LearnApp(arg.conffile, prefix=arg.prefix, db=arg.db, check=arg.check)
-    except Exception as e:
-        logging.critical('Failed to start application')
-        raise e
+        learnapp = LearnApp(arg.conffile, prefix=arg.prefix, db=arg.db,
+                            check=arg.check)
+    except Exception:
+        logging.critical('Failed to start application.')
+        sys.exit(1)
     # --- create web application
-    logging.info('Starting Web App (tornado)')
+    logging.info('Starting Web App (tornado)...')
     try:
         webapp = WebApplication(learnapp, debug=arg.debug)
-    except Exception as e:
+    except Exception:
         logging.critical('Failed to start web application.')
-        raise e
+        sys.exit(1)
     # --- get SSL certificates
     if 'XDG_DATA_HOME' in os.environ:
@@ -481,21 +482,21 @@ def main():
                                 path.join(certs_dir, 'privkey.pem'))
     except FileNotFoundError:
         logging.critical(f'SSL certificates missing in {certs_dir}')
-        sys.exit(-1)
+        sys.exit(1)
     # --- create webserver
     try:
         httpserver = tornado.httpserver.HTTPServer(webapp, ssl_options=ssl_ctx)
     except ValueError:
         logging.critical('Certificates cert.pem and privkey.pem not found')
-        sys.exit(-1)
+        sys.exit(1)
     httpserver.listen(arg.port)
     logging.info(f'Listening on port {arg.port}.')
     # --- run webserver
-    logging.info('Webserver running...  (Ctrl-C to stop)')
     signal.signal(signal.SIGINT, signal_handler)
+    logging.info('Webserver running.  (Ctrl-C to stop)')
     try:
         tornado.ioloop.IOLoop.current().start()  # running...
@@ -33,7 +33,11 @@
   </button>
   <div class="collapse navbar-collapse" id="navbarText">
-    <ul class="navbar-nav mr-auto"></ul>
+    <ul class="navbar-nav mr-auto">
+      <li class="nav-item active">
+        <a class="nav-link" href="#">Tópicos<span class="sr-only">(current)</span></a>
+      </li>
+    </ul>
     <ul class="navbar-nav">
       <li class="nav-item dropdown">
 <!DOCTYPE html>
 <html>
 <head>
-	<title>iLearn</title>
-	<link rel="icon" href="/static/favicon.ico">
+    <title>iLearn</title>
+    <link rel="icon" href="/static/favicon.ico">
-	<meta charset="utf-8">
-	<meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
-	<meta name="author" content="Miguel Barão">
+    <meta charset="utf-8">
+    <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
+    <meta name="author" content="Miguel Barão">
 <!-- MathJax -->
-	<script type="text/x-mathjax-config">
-		MathJax.Hub.Config({
-			tex2jax: {
-				inlineMath: [["$$$","$$$"], ["$","$"], ["\\(","\\)"]]
-			}
-		});
-	</script>
-	<script type="text/javascript" src="/static/mathjax/MathJax.js?delayStartupUntil=onload&config=TeX-AMS_CHTML-full"></script>
+    <script type="text/x-mathjax-config">
+        MathJax.Hub.Config({
+            tex2jax: {
+                inlineMath: [["$$$","$$$"], ["$","$"], ["\\(","\\)"]]
+            }
+        });
+    </script>
+    <script type="text/javascript" src="/static/mathjax/MathJax.js?delayStartupUntil=onload&config=TeX-AMS_CHTML-full"></script>
 <!-- Styles -->
-	<link rel="stylesheet" href="/static/mdbootstrap/css/bootstrap.min.css">
-	<link rel="stylesheet" href="/static/mdbootstrap/css/mdb.min.css">
-	<link rel="stylesheet" href="/static/codemirror/lib/codemirror.css">
-	<link rel="stylesheet" href="/static/css/animate.min.css">
-	<link rel="stylesheet" href="/static/css/github.css">
-	<link rel="stylesheet" href="/static/css/topic.css">
+    <link rel="stylesheet" href="/static/mdbootstrap/css/bootstrap.min.css">
+    <link rel="stylesheet" href="/static/mdbootstrap/css/mdb.min.css">
+    <link rel="stylesheet" href="/static/codemirror/lib/codemirror.css">
+    <link rel="stylesheet" href="/static/css/animate.min.css">
+    <link rel="stylesheet" href="/static/css/github.css">
+    <link rel="stylesheet" href="/static/css/topic.css">
 <!-- Scripts -->
-  <script defer src="/static/mdbootstrap/js/jquery-3.3.1.min.js"></script>
-  <script defer src="/static/mdbootstrap/js/popper.min.js"></script>
-  <script defer src="/static/mdbootstrap/js/bootstrap.min.js"></script>
-  <script defer src="/static/mdbootstrap/js/mdb.min.js"></script>
-  <script defer src="/static/fontawesome-free/js/all.min.js"></script>
-  <script defer src="/static/codemirror/lib/codemirror.js"></script>
-  <script defer src="/static/js/topic.js"></script>
+    <script defer src="/static/mdbootstrap/js/jquery-3.3.1.min.js"></script>
+    <script defer src="/static/mdbootstrap/js/popper.min.js"></script>
+    <script defer src="/static/mdbootstrap/js/bootstrap.min.js"></script>
+    <script defer src="/static/mdbootstrap/js/mdb.min.js"></script>
+    <script defer src="/static/fontawesome-free/js/all.min.js"></script>
+    <script defer src="/static/codemirror/lib/codemirror.js"></script>
+    <script defer src="/static/js/topic.js"></script>
 </head>
 <!-- ===================================================================== -->
 <body>
 <!-- Navbar -->
 <nav class="navbar navbar-expand-sm fixed-top navbar-dark bg-primary">
-	<img src="/static/logo_horizontal.png" height="48" width="120" class="navbar-brand" alt="UEvora">
-	<button class="navbar-toggler" type="button" data-toggle="collapse" data-target="#navbarText" aria-controls="navbarText" aria-expanded="false" aria-label="Toggle navigation">
-	<span class="navbar-toggler-icon"></span>
-	</button>
-
-	<div class="collapse navbar-collapse" id="navbarText">
-		<ul class="navbar-nav mr-auto"></ul>
-
-		<ul class="navbar-nav">
-			<li class="nav-item dropdown">
-				<a class="nav-link dropdown-toggle" href="#" id="navbarDropdown" role="button" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">
-					<i class="fas fa-user" aria-hidden="true"></i>
-					<span id="name">{{ escape(name) }}</span>
-					<span class="caret"></span>
-				</a>
-				<div class="dropdown-menu dropdown-menu-right" aria-labelledby="navbarDropdown">
-					<a class="dropdown-item" href="/">Voltar aos tópicos</a>
-				</div>
-			</li>
-		</ul>
-	</div>
+    <img src="/static/logo_horizontal.png" height="48" width="120" class="navbar-brand" alt="UEvora">
+    <button class="navbar-toggler" type="button" data-toggle="collapse" data-target="#navbarText" aria-controls="navbarText" aria-expanded="false" aria-label="Toggle navigation">
+    <span class="navbar-toggler-icon"></span>
+    </button>
+
+    <div class="collapse navbar-collapse" id="navbarText">
+        <ul class="navbar-nav mr-auto">
+            <li class="nav-item">
+                <a class="nav-link" href="/">Tópicos</a>
+            </li>
+        </ul>
+
+        <ul class="navbar-nav">
+            <li class="nav-item dropdown">
+                <a class="nav-link dropdown-toggle" href="#" id="navbarDropdown" role="button" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">
+                    <i class="fas fa-user" aria-hidden="true"></i>
+                    <span id="name">{{ escape(name) }}</span>
+                    <span class="caret"></span>
+                </a>
+                <div class="dropdown-menu dropdown-menu-right" aria-labelledby="navbarDropdown">
+                <a class="dropdown-item" href="/logout">Sair</a>
+                </div>
+            </li>
+        </ul>
+    </div>
 </nav>
 <!-- ===================================================================== -->
 <div class="progress">
-	<div class="progress-bar bg-primary" id="topic_progress" role="progressbar" aria-valuenow="0" aria-valuemin="0" aria-valuemax="100" style="min-width: 1em;width: 0%"></div>
+    <div class="progress-bar bg-primary" id="topic_progress" role="progressbar" aria-valuenow="0" aria-valuemin="0" aria-valuemax="100" style="min-width: 1em;width: 0%"></div>
 </div>
 <!-- ===================================================================== -->
 <!-- main panel with questions -->
 <div class="container" id="container">
-	<div id="notifications"></div>
-
-	<div class="my-5" id="content">
-		<form action="/question" method="post" id="question_form" autocomplete="off">
-			{% module xsrf_form_html() %}
-			<div id="question_div"></div>
-		</form>
-
-		<div id="comments"></div>
-	</div>
-
-	<div id="wrong" style="display: none">
-		<div class="alert alert-danger">
-			<i class="fas fa-thumbs-down fa-3x"></i>
-			<br><br>
-			Desta vez não acertou, mas também se aprende com os erros...
-			<br>
-			<div id="show_solution_on_right">
-				<a href="#solution" id="link_solution_on_wrong">Ver solução</a>
-			</div>
-		</div>
-	</div>
-
-	<div id="right" style="display: none">
-		<div class="alert alert-success">
-			<i class="fas fa-thumbs-up fa-3x"></i>
-			<br><br>
-			Excelente resposta!
-			<br>
-			<div id="show_solution_on_right">
-				<a href="#solution" id="link_solution_on_right">Ver solução</a>
-			</div>
-		</div>
-	</div>
-
-	<div id="solution"></div>
-
-	<!-- reponder / continuar -->
-	<a class="btn btn-primary btn-lg btn-block my-5" id="submit" data-toggle="tooltip" data-placement="right" href="#solution"></a>
-	<!-- title="Shift-Enter" -->
+    <div id="notifications"></div>
+
+    <div class="my-5" id="content">
+        <form action="/question" method="post" id="question_form" autocomplete="off">
+            {% module xsrf_form_html() %}
+            <div id="question_div"></div>
+        </form>
+
+        <div id="comments"></div>
+    </div>
+
+    <div id="wrong" style="display: none">
+        <div class="alert alert-danger">
+            <i class="fas fa-thumbs-down fa-3x"></i>
+            <br><br>
+            Desta vez não acertou, mas também se aprende com os erros...
+            <br>
+            <div id="show_solution_on_right">
+                <a href="#solution" id="link_solution_on_wrong">Ver solução</a>
+            </div>
+        </div>
+    </div>
+
+    <div id="right" style="display: none">
+        <div class="alert alert-success">
+            <i class="fas fa-thumbs-up fa-3x"></i>
+            <br><br>
+            Excelente resposta!
+            <br>
+            <div id="show_solution_on_right">
+                <a href="#solution" id="link_solution_on_right">Ver solução</a>
+            </div>
+        </div>
+    </div>
+
+    <div id="solution"></div>
+
+    <!-- reponder / continuar -->
+    <a class="btn btn-primary btn-lg btn-block my-5" id="submit" data-toggle="tooltip" data-placement="right" href="#solution"></a>
+    <!-- title="Shift-Enter" -->
 </div>
 </body>
	@@ -1,99 +0,0 @@	@@ -1,99 +0,0 @@
1	-# QFactory is a class that can generate question instances, e.g. by shuffling
2	-# options, running a script to generate the question, etc.
3	-#
4	-# To generate an instance of a question we use the method generate() where
5	-# the argument is the reference of the question we wish to produce.
6	-#
7	-# Example:
8	-#
9	-# # read question from file
10	-# qdict = tools.load_yaml(filename)
11	-# qfactory = QFactory(qdict)
12	-# question = qfactory.generate()
13	-#
14	-# # experiment answering one question and correct it
15	-# question.updateAnswer('42') # insert answer
16	-# grade = question.correct() # correct answer
17	-
18	-# An instance of an actual question is an object that inherits from Question()
19	-#
20	-# Question - base class inherited by other classes
21	-# QuestionInformation - not a question, just a box with content
22	-# QuestionRadio - single choice from a list of options
23	-# QuestionCheckbox - multiple choice, equivalent to multiple true/false
24	-# QuestionText - line of text compared to a list of acceptable answers
25	-# QuestionTextRegex - line of text matched against a regular expression
26	-# QuestionTextArea - corrected by an external program
27	-# QuestionNumericInterval - line of text parsed as a float
28	-
29	-# base
30	-from os import path
31	-import logging
32	-
33	-# project
34	-from aprendizations.tools import run_script
35	-from aprendizations.questions import (QuestionInformation, QuestionRadio,
36	- QuestionCheckbox, QuestionText,
37	- QuestionTextRegex, QuestionTextArea,
38	- QuestionNumericInterval,
39	- QuestionException)
40	-
41	-# setup logger for this module
42	-logger = logging.getLogger(__name__)
43	-
44	-
45	-# ===========================================================================
46	-# Question Factory
47	-# ===========================================================================
48	-class QFactory(object):
49	- # Depending on the type of question, a different question class will be
50	- # instantiated. All these classes derive from the base class `Question`.
51	- _types = {
52	- 'radio': QuestionRadio,
53	- 'checkbox': QuestionCheckbox,
54	- 'text': QuestionText,
55	- 'text-regex': QuestionTextRegex,
56	- 'numeric-interval': QuestionNumericInterval,
57	- 'textarea': QuestionTextArea,
58	- # -- informative panels --
59	- 'information': QuestionInformation,
60	- 'warning': QuestionInformation,
61	- 'alert': QuestionInformation,
62	- 'success': QuestionInformation,
63	- }
64	-
65	- def __init__(self, question_dict={}):
66	- self.question = question_dict
67	-
68	- # -----------------------------------------------------------------------
69	- # Given a ref returns an instance of a descendent of Question(),
70	- # i.e. a question object (radio, checkbox, ...).
71	- # -----------------------------------------------------------------------
72	- def generate(self):
73	- logger.debug(f'Generating "{self.question["ref"]}"...')
74	- # Shallow copy so that script generated questions will not replace
75	- # the original generators
76	- q = self.question.copy()
77	-
78	- # If question is of generator type, an external program will be run
79	- # which will print a valid question in yaml format to stdout. This
80	- # output is then yaml parsed into a dictionary `q`.
81	- if q['type'] == 'generator':
82	- logger.debug(f' \\_ Running "{q["script"]}".')
83	- q.setdefault('args', [])
84	- q.setdefault('stdin', '')
85	- script = path.join(q['path'], q['script'])
86	- out = run_script(script=script, args=q['args'], stdin=q['stdin'])
87	- q.update(out)
88	-
89	- # Finally we create an instance of Question()
90	- try:
91	- qinstance = self._types[q['type']](q) # instance matching class
92	- except QuestionException as e:
93	- logger.error(e)
94	- raise e
95	- except KeyError:
96	- logger.error(f'Invalid type "{q["type"]}" in "{q["ref"]}"')
97	- raise
98	- else:
99	- return qinstance
	@@ -15,7 +15,7 @@ import networkx as nx		@@ -15,7 +15,7 @@ import networkx as nx
15	# this project	15	# this project
16	from aprendizations.models import Student, Answer, Topic, StudentTopic	16	from aprendizations.models import Student, Answer, Topic, StudentTopic
17	from aprendizations.knowledge import StudentKnowledge	17	from aprendizations.knowledge import StudentKnowledge
18	-from aprendizations.factory import QFactory	18	+from aprendizations.questions import QFactory
19	from aprendizations.tools import load_yaml	19	from aprendizations.tools import load_yaml
20		20
21	# setup logger for this module	21	# setup logger for this module
	@@ -30,7 +30,7 @@ class Question(dict):		@@ -30,7 +30,7 @@ class Question(dict):
30	def __init__(self, q):	30	def __init__(self, q):
31	super().__init__(q)	31	super().__init__(q)
32		32
33	- # add these if missing	33	+ # add required keys if missing
34	self.set_defaults({	34	self.set_defaults({
35	'title': '',	35	'title': '',
36	'answer': None,	36	'answer': None,
	@@ -368,3 +368,81 @@ class QuestionInformation(Question):		@@ -368,3 +368,81 @@ class QuestionInformation(Question):
368	def correct(self):	368	def correct(self):
369	super().correct()	369	super().correct()
370	self['grade'] = 1.0 # always "correct" but points should be zero!	370	self['grade'] = 1.0 # always "correct" but points should be zero!
		371	+
		372	+
		373	+# ===========================================================================
		374	+# QFactory is a class that can generate question instances, e.g. by shuffling
		375	+# options, running a script to generate the question, etc.
		376	+#
		377	+# To generate an instance of a question we use the method generate() where
		378	+# the argument is the reference of the question we wish to produce.
		379	+# The generate() method returns a question instance of the correct class.
		380	+#
		381	+# Example:
		382	+#
		383	+# # generate a question instance from a dictionary
		384	+# qdict = {
		385	+# 'type': 'radio',
		386	+# 'text': 'Choose one',
		387	+# 'options': ['a', 'b']
		388	+# }
		389	+# qfactory = QFactory(qdict)
		390	+# question = qfactory.generate()
		391	+#
		392	+# # answer one question and correct it
		393	+# question['answer'] = 42 # set answer
		394	+# question.correct() # correct answer
		395	+# print(question['grade']) # print grade
		396	+# ===========================================================================
		397	+class QFactory(object):
		398	+ # Depending on the type of question, a different question class will be
		399	+ # instantiated. All these classes derive from the base class `Question`.
		400	+ _types = {
		401	+ 'radio': QuestionRadio,
		402	+ 'checkbox': QuestionCheckbox,
		403	+ 'text': QuestionText,
		404	+ 'text-regex': QuestionTextRegex,
		405	+ 'numeric-interval': QuestionNumericInterval,
		406	+ 'textarea': QuestionTextArea,
		407	+ # -- informative panels --
		408	+ 'information': QuestionInformation,
		409	+ 'warning': QuestionInformation,
		410	+ 'alert': QuestionInformation,
		411	+ 'success': QuestionInformation,
		412	+ }
		413	+
		414	+ def __init__(self, question_dict={}):
		415	+ self.question = question_dict
		416	+
		417	+ # -----------------------------------------------------------------------
		418	+ # Given a ref returns an instance of a descendent of Question(),
		419	+ # i.e. a question object (radio, checkbox, ...).
		420	+ # -----------------------------------------------------------------------
		421	+ def generate(self):
		422	+ logger.debug(f'Generating "{self.question["ref"]}"...')
		423	+ # Shallow copy so that script generated questions will not replace
		424	+ # the original generators
		425	+ q = self.question.copy()
		426	+
		427	+ # If question is of generator type, an external program will be run
		428	+ # which will print a valid question in yaml format to stdout. This
		429	+ # output is then yaml parsed into a dictionary `q`.
		430	+ if q['type'] == 'generator':
		431	+ logger.debug(f' \\_ Running "{q["script"]}".')
		432	+ q.setdefault('args', [])
		433	+ q.setdefault('stdin', '')
		434	+ script = path.join(q['path'], q['script'])
		435	+ out = run_script(script=script, args=q['args'], stdin=q['stdin'])
		436	+ q.update(out)
		437	+
		438	+ # Finally we create an instance of Question()
		439	+ try:
		440	+ qinstance = self._types[q['type']](q) # instance matching class
		441	+ except QuestionException as e:
		442	+ logger.error(e)
		443	+ raise e
		444	+ except KeyError:
		445	+ logger.error(f'Invalid type "{q["type"]}" in "{q["ref"]}"')
		446	+ raise
		447	+ else:
		448	+ return qinstance