- replace (scale_points, scale_min, scale_max) by "scale: [0, 20]"

- updates demo.yaml - correct-question.py changed to count the number of correct colors - catch exception loading test configuration

- replace (scale_points, scale_min, scale_max) by "scale: [0, 20]"
- updates demo.yaml - correct-question.py changed to count the number of correct colors - catch exception loading test configuration
Miguel Barão
1 parent a08db79d
Showing 6 changed files with 84 additions and 62 deletions Show diff stats
demo/demo.yaml
demo/questions/correct/correct-question.py
demo/questions/generators/generate-question.py
perguntations/app.py
perguntations/templates/grade.html
perguntations/test.py
 ---
 # ============================================================================
-# The test reference should be a unique identifier. It is saved in the database
-# so that queries can be done in the terminal like
-#     sqlite3 students.db "select * from tests where ref='demo'"
+# Unique identifier of the test.
+# Database queries can be done in the terminal with
+#     sqlite3 students.db "select * from tests where ref='tutorial'"
 ref: tutorial
-# Database with student credentials and grades of all questions and tests done
-# The database is an sqlite3 file generate with the command initdb
+# Database file that includes student credentials, tests and questions grades.
+# It's a sqlite3 database generated with the command 'initdb'
 database: students.db
-# Directory where the tests including submitted answers and grades are stored.
-# The submitted tests and their corrections can be reviewed later.
+# Directory where the submitted and corrected test are stored for later review.
 answers_dir: ans
 # --- optional settings: -----------------------------------------------------
-# You may wish to refer the course, year or kind of test
+# Title of this test, e.g. course name, year or test number
 # (default: '')
 title: Teste de demonstração (tutorial)
 # Duration in minutes.
 # (0 or undefined means infinite time)
 duration: 2
-autosubmit: true
-# Show points for each question, scale 0-20.
+# Automatic test submission after the timeout 'duration'?
 # (default: false)
+autosubmit: true
+
+# Show points for each question (min and max).
+# (default: true)
 show_points: true
-# scale final grade to the interval [scale_min, scale_max]
-# (default: scale to [0,20])
-scale_max: 20
-scale_min: 0
-scale_points: true
+# scale final grade to an interval, e.g. [0, 20], keeping the relative weight
+# of the points declared in the questions below.
+# (default: no scaling, just use question points)
+scale: [0, 5]
+
+# DEPRECATED: old version, to be removed
+# scale_max: 20
+# scale_min: 0
+# scale_points: true
 # ----------------------------------------------------------------------------
 # Base path applied to the questions files and all the scripts
@@ -50,7 +56,7 @@ files:
 # The order is preserved.
 # There are several ways to define each question (explained below).
 questions:
-  - tut-test
+  - ref: tut-test
   - tut-questions
   - tut-radio
 #!/usr/bin/env python3
+'''
+Demonstação de um script de correcção
+'''
+
 import re
 import sys
-msg1 = '''---
-grade: 1.0
-comments:  Muito bem!
-'''
+s = sys.stdin.read()
-msg0 = '''
-grade: 0.0
-comments: A resposta correcta é "red green blue".
-'''
+ans = set(re.findall(r'[\w]+', s.lower()))  # get words in lowercase
+rgb = set(['red', 'green', 'blue'])     # the correct answer
-s = sys.stdin.read()
+# a nota é o número de cores certas menos o número de erradas
+grade = max(0,
+            len(rgb.intersection(ans)) - len(ans.difference(rgb))) / 3
-answer = set(re.findall(r'[\w]+', s.lower()))  # get words in lowercase
-rgb_colors = set(['red', 'green', 'blue'])     # the correct answer
+if ans == rgb:
+    print('---\n'
+          'grade: 1.0\n'
+          'comments:  Muito bem!')
-if answer == rgb_colors:
-    print(msg1)
 else:
-    print(msg0)
+    print('---\n'
+          f'grade: {grade}\n'
+          'comments: A resposta correcta é "red green blue".')
@@ -18,10 +18,11 @@ print(f&quot;&quot;&quot;---
 type: text
 title: Geradores de perguntas
 text: |
-  Existe a possibilidade da pergunta ser gerada por um programa externo.
-  Este programa deve escrever no `stdout` uma pergunta em formato `yaml` como
-  os anteriores. Pode também receber argumentos para parametrizar a geração da
-  pergunta. Aqui está um exemplo de uma pergunta gerada por um script python:
+  Existe a possibilidade da pergunta ser gerada por um programa externo. Este
+  programa deve escrever no `stdout` uma pergunta em formato `yaml` como nos
+  exemplos anteriores. Pode também receber argumentos para parametrizar a
+  geração da pergunta. Aqui está um exemplo de uma pergunta gerada por um
+  script python:
   ```python
       #!/usr/bin/env python3
@@ -86,7 +86,12 @@ class App():
         self.allowed = set([])  # '0' is hardcoded to allowed elsewhere
         logger.info('Loading test configuration "%s".', conf["testfile"])
-        testconf = load_yaml(conf['testfile'])
+        try:
+            testconf = load_yaml(conf['testfile'])
+        except Exception as exc:
+            logger.critical('Error loading test configuration YAML.')
+            raise AppException(exc)
+
         testconf.update(conf)  # command line options override configuration
         # start test factory
@@ -43,11 +43,11 @@
     {% if t['state'] == 'FINISHED' %}
       <h1>Resultado:
         <strong>{{ f'{round(t["grade"], 1)}' }}</strong>
-        valores na escala de {{t['scale_min']}} a {{t['scale_max']}}.
+        valores na escala de {{t['scale'][0]}} a {{t['scale'][1]}}.
       </h1>
       <p>O seu teste foi registado.<br>
       Pode fechar o browser e desligar o computador.</p>
-      {% if t['grade'] - t['scale_min'] >= 0.75*(t['scale_max'] - t['scale_min']) %}
+      {% if t['grade'] - t['scale'][0] >= 0.75*(t['scale'][1] - t['scale'][0]) %}
         <i class="fas fa-thumbs-up fa-5x text-success" aria-hidden="true"></i>
       {% end %}
     {% elif t['state'] == 'QUIT' %}
@@ -78,19 +78,19 @@
             <td> <!-- progress column -->
               <div class="progress" style="height: 20px;">
                 <div class="progress-bar
-                  {% if g[1] - t['scale_min'] < 0.5*(t['scale_max'] - t['scale_min']) %}
+                  {% if g[1] - t['scale'][0] < 0.5*(t['scale'][1] - t['scale'][0]) %}
                       bg-danger
-                  {% elif g[1]  - t['scale_min'] < 0.75*(t['scale_max'] - t['scale_min']) %}
+                  {% elif g[1]  - t['scale'][0] < 0.75*(t['scale'][1] - t['scale'][0]) %}
                       bg-warning
                   {% else %}
                       bg-success
                   {% end %}
                   "
                   role="progressbar"
-                  aria-valuenow="{{ round(100*(g[1] - t['scale_min'])/(t['scale_max'] - t['scale_min'])) }}"
+                  aria-valuenow="{{ 100*(g[1] - t['scale'][0])/(t['scale'][1] - t['scale'][0]) }}"
                   aria-valuemin="0"
                   aria-valuemax="100"
-                                    style="min-width: 2em; width: {{ round(100*(g[1]-t['scale_min'])/(t['scale_max']-t['scale_min'])) }}%;"
+                                    style="min-width: 2em; width: {{ 100*(g[1]-t['scale'][0])/(t['scale'][1]-t['scale'][0]) }}%;"
                   >
                     {{ str(round(g[1], 1)) }}
@@ -42,10 +42,8 @@ class TestFactory(dict):
         # --- set test defaults and then use given configuration
         super().__init__({  # defaults
             'title': '',
-            'show_points': False,
-            'scale_points': True,
-            'scale_max': 20.0,
-            'scale_min': 0.0,
+            'show_points': True,
+            'scale': None,  # or [0, 20]
             'duration': 0,  # 0=infinite
             'autosubmit': False,
             'debug': False,
@@ -197,11 +195,12 @@ class TestFactory(dict):
     def check_grade_scaling(self):
         '''Just informs the scale limits'''
-        if self['scale_points']:
-            smin, smax = self["scale_min"], self["scale_max"]
-            logger.info('Grades will be scaled to [%g, %g]', smin, smax)
-        else:
-            logger.info('Grades are not being scaled.')
+        if 'scale_points' in self:
+            msg = ('*** DEPRECATION WARNING: *** scale_points, scale_min, '
+                   'scale_max were replaced by "scale: [min, max]".')
+            logger.warning(msg)
+            self['scale'] = [self['scale_min'], self['scale_max']]
+
     # ------------------------------------------------------------------------
     def sanity_checks(self):
@@ -254,25 +253,32 @@ class TestFactory(dict):
             test.append(question)
-        # normalize question points to scale
-        if self['scale_points']:
-            total_points = sum(q['points'] for q in test)
-            if total_points == 0:
-                logger.warning('Can\'t scale, total points in the test is 0!')
-            else:
-                scale = (self['scale_max'] - self['scale_min']) / total_points
+        # setup scale
+        total_points = sum(q['points'] for q in test)
+
+        if total_points > 0:
+            # normalize question points to scale
+            if self['scale'] is not None:
+                scale_min, scale_max = self['scale']
                 for question in test:
-                    question['points'] *= scale
+                    question['points'] *= (scale_max - scale_min) / total_points
+            else:
+                self['scale'] = [0, total_points]
+        else:
+            logger.warning('Total points is **ZERO**.')
+            if self['scale'] is None:
+                self['scale'] = [0, 20]
         if nerr > 0:
             logger.error('%s errors found!', nerr)
+        # these will be copied to the test instance
         inherit = {'ref', 'title', 'database', 'answers_dir',
                    'questions_dir', 'files',
                    'duration', 'autosubmit',
-                   'scale_min', 'scale_max', 'show_points',
+                   'scale', 'show_points',
                    'show_ref', 'debug', }
-        # NOT INCLUDED: scale_points, testfile, allow_all, review
+        # NOT INCLUDED:  testfile, allow_all, review
         return Test({
             **{'student': student, 'questions': test},
@@ -318,6 +324,7 @@ class Test(dict):
         '''Corrects all the answers of the test and computes the final grade'''
         self['finish_time'] = datetime.now()
         self['state'] = 'FINISHED'
+
         grade = 0.0
         for question in self['questions']:
             await question.correct_async()
@@ -325,8 +332,8 @@ class Test(dict):
             logger.debug('Correcting %30s: %3g%%',
                          question["ref"], question["grade"]*100)
-        # truncate to avoid negative grade and adjust scale
-        self['grade'] = max(0.0, grade) + self['scale_min']
+        # truncate to avoid negative final grade and adjust scale
+        self['grade'] = max(0.0, grade) + self['scale'][0]
         return self['grade']
     # ------------------------------------------------------------------------
1	---	1	---
2	# ============================================================================	2	# ============================================================================
3	-# The test reference should be a unique identifier. It is saved in the database
4	-# so that queries can be done in the terminal like
5	-# sqlite3 students.db "select * from tests where ref='demo'"	3	+# Unique identifier of the test.
		4	+# Database queries can be done in the terminal with
		5	+# sqlite3 students.db "select * from tests where ref='tutorial'"
6	ref: tutorial	6	ref: tutorial
7		7
8	-# Database with student credentials and grades of all questions and tests done
9	-# The database is an sqlite3 file generate with the command initdb	8	+# Database file that includes student credentials, tests and questions grades.
		9	+# It's a sqlite3 database generated with the command 'initdb'
10	database: students.db	10	database: students.db
11		11
12	-# Directory where the tests including submitted answers and grades are stored.
13	-# The submitted tests and their corrections can be reviewed later.	12	+# Directory where the submitted and corrected test are stored for later review.
14	answers_dir: ans	13	answers_dir: ans
15		14
16	# --- optional settings: -----------------------------------------------------	15	# --- optional settings: -----------------------------------------------------
17		16
18	-# You may wish to refer the course, year or kind of test	17	+# Title of this test, e.g. course name, year or test number
19	# (default: '')	18	# (default: '')
20	title: Teste de demonstração (tutorial)	19	title: Teste de demonstração (tutorial)
21		20
22	# Duration in minutes.	21	# Duration in minutes.
23	# (0 or undefined means infinite time)	22	# (0 or undefined means infinite time)
24	duration: 2	23	duration: 2
25	-autosubmit: true
26		24
27	-# Show points for each question, scale 0-20.	25	+# Automatic test submission after the timeout 'duration'?
28	# (default: false)	26	# (default: false)
		27	+autosubmit: true
		28	+
		29	+# Show points for each question (min and max).
		30	+# (default: true)
29	show_points: true	31	show_points: true
30		32
31	-# scale final grade to the interval [scale_min, scale_max]
32	-# (default: scale to [0,20])
33	-scale_max: 20
34	-scale_min: 0
35	-scale_points: true	33	+# scale final grade to an interval, e.g. [0, 20], keeping the relative weight
		34	+# of the points declared in the questions below.
		35	+# (default: no scaling, just use question points)
		36	+scale: [0, 5]
		37	+
		38	+# DEPRECATED: old version, to be removed
		39	+# scale_max: 20
		40	+# scale_min: 0
		41	+# scale_points: true
36		42
37	# ----------------------------------------------------------------------------	43	# ----------------------------------------------------------------------------
38	# Base path applied to the questions files and all the scripts	44	# Base path applied to the questions files and all the scripts
	@@ -50,7 +56,7 @@ files:		@@ -50,7 +56,7 @@ files:
50	# The order is preserved.	56	# The order is preserved.
51	# There are several ways to define each question (explained below).	57	# There are several ways to define each question (explained below).
52	questions:	58	questions:
53	- - tut-test	59	+ - ref: tut-test
54	- tut-questions	60	- tut-questions
55		61
56	- tut-radio	62	- tut-radio
	@@ -43,11 +43,11 @@		@@ -43,11 +43,11 @@
43	{% if t['state'] == 'FINISHED' %}	43	{% if t['state'] == 'FINISHED' %}
44	<h1>Resultado:	44	<h1>Resultado:
45	<strong>{{ f'{round(t["grade"], 1)}' }}</strong>	45	<strong>{{ f'{round(t["grade"], 1)}' }}</strong>
46	- valores na escala de {{t['scale_min']}} a {{t['scale_max']}}.	46	+ valores na escala de {{t['scale'][0]}} a {{t['scale'][1]}}.
47	</h1>	47	</h1>
48	<p>O seu teste foi registado.<br>	48	<p>O seu teste foi registado.<br>
49	Pode fechar o browser e desligar o computador.</p>	49	Pode fechar o browser e desligar o computador.</p>
50	- {% if t['grade'] - t['scale_min'] >= 0.75*(t['scale_max'] - t['scale_min']) %}	50	+ {% if t['grade'] - t['scale'][0] >= 0.75*(t['scale'][1] - t['scale'][0]) %}
51	<i class="fas fa-thumbs-up fa-5x text-success" aria-hidden="true"></i>	51	<i class="fas fa-thumbs-up fa-5x text-success" aria-hidden="true"></i>
52	{% end %}	52	{% end %}
53	{% elif t['state'] == 'QUIT' %}	53	{% elif t['state'] == 'QUIT' %}
	@@ -78,19 +78,19 @@		@@ -78,19 +78,19 @@
78	<td> <!-- progress column -->	78	<td> <!-- progress column -->
79	<div class="progress" style="height: 20px;">	79	<div class="progress" style="height: 20px;">
80	<div class="progress-bar	80	<div class="progress-bar
81	- {% if g[1] - t['scale_min'] < 0.5*(t['scale_max'] - t['scale_min']) %}	81	+ {% if g[1] - t['scale'][0] < 0.5*(t['scale'][1] - t['scale'][0]) %}
82	bg-danger	82	bg-danger
83	- {% elif g[1] - t['scale_min'] < 0.75*(t['scale_max'] - t['scale_min']) %}	83	+ {% elif g[1] - t['scale'][0] < 0.75*(t['scale'][1] - t['scale'][0]) %}
84	bg-warning	84	bg-warning
85	{% else %}	85	{% else %}
86	bg-success	86	bg-success
87	{% end %}	87	{% end %}
88	"	88	"
89	role="progressbar"	89	role="progressbar"
90	- aria-valuenow="{{ round(100*(g[1] - t['scale_min'])/(t['scale_max'] - t['scale_min'])) }}"	90	+ aria-valuenow="{{ 100*(g[1] - t['scale'][0])/(t['scale'][1] - t['scale'][0]) }}"
91	aria-valuemin="0"	91	aria-valuemin="0"
92	aria-valuemax="100"	92	aria-valuemax="100"
93	- style="min-width: 2em; width: {{ round(100*(g[1]-t['scale_min'])/(t['scale_max']-t['scale_min'])) }}%;"	93	+ style="min-width: 2em; width: {{ 100*(g[1]-t['scale'][0])/(t['scale'][1]-t['scale'][0]) }}%;"
94	>	94	>
95		95
96	{{ str(round(g[1], 1)) }}	96	{{ str(round(g[1], 1)) }}