Fixes to ch7 per previous chpater reviews

Author: alandmoore

Chapter07/ABQ_Data_Entry/abq_data_entry/models.py

@@ -64,7 +64,7 @@ def save_record(self, data):
     """Save a dict of data to the CSV file"""
     newfile = not self.file.exists()
 
-    with open(self.file, 'a') as fh:
+    with open(self.file, 'a', newline='') as fh:
       csvwriter = csv.DictWriter(fh, fieldnames=self.fields.keys())
       if newfile:
         csvwriter.writeheader()

Chapter07/ABQ_Data_Entry/abq_data_entry/views.py

@@ -58,21 +58,21 @@ def __init__(self, parent, model, settings, *args, **kwargs):
       field_spec=fields['Time'],
       var=self._vars['Time'],
     ).grid(row=0, column=1)
+    w.LabelInput(
+      r_info, "Technician",
+      field_spec=fields['Technician'],
+      var=self._vars['Technician'],
+    ).grid(row=0, column=2)
+    # line 2
     w.LabelInput(
       r_info, "Lab",
       field_spec=fields['Lab'],
       var=self._vars['Lab'],
-    ).grid(row=0, column=2)
-    # line 2
+    ).grid(row=1, column=0)
     w.LabelInput(
       r_info, "Plot",
       field_spec=fields['Plot'],
       var=self._vars['Plot'],
-    ).grid(row=1, column=0)
-    w.LabelInput(
-      r_info, "Technician",
-      field_spec=fields['Technician'],
-      var=self._vars['Technician'],
     ).grid(row=1, column=1)
     w.LabelInput(
       r_info, "Seed Sample",

Chapter07/ABQ_Data_Entry/abq_data_entry/widgets.py

@@ -190,7 +190,7 @@ def _set_focus_update_var(self, event):
     if self.focus_update_var and not self.error.get():
       self.focus_update_var.set(value)
 
-  def _set_minimum(self, *args):
+  def _set_minimum(self, *_):
     current = self.get()
     try:
       new_min = self.min_var.get()
@@ -203,7 +203,7 @@ def _set_minimum(self, *args):
       self.variable.set(current)
     self.trigger_focusout_validation()
 
-  def _set_maximum(self, *args):
+  def _set_maximum(self, *_):
     current = self.get()
     try:
       new_max = self.max_var.get()
@@ -219,13 +219,13 @@ def _set_maximum(self, *args):
   def _key_validate(
     self, char, index, current, proposed, action, **kwargs
   ):
+    if action == '0':
+      return True
     valid = True
     min_val = self.cget('from')
     max_val = self.cget('to')
     no_negative = min_val >= 0
     no_decimal = self.precision >= 0
-    if action == '0':
-      return True
 
     # First, filter out obviously invalid keystrokes
     if any([
@@ -260,55 +260,61 @@ def _focusout_validate(self, **kwargs):
     max_val = self.cget('to')
 
     try:
-      value = Decimal(value)
+      d_value = Decimal(value)
     except InvalidOperation:
-      self.error.set('Invalid number string: {}'.format(value))
+      self.error.set(f'Invalid number string: {value}')
       return False
 
-    if value < min_val:
-      self.error.set('Value is too low (min {})'.format(min_val))
+    if d_value < min_val:
+      self.error.set(f'Value is too low (min {min_val})')
+      valid = False
+    if d_value > max_val:
+      self.error.set(f'Value is too high (max {max_val})')
       valid = False
-    if value > max_val:
-      self.error.set('Value is too high (max {})'.format(max_val))
 
     return valid
 
+class ValidatedRadio(ttk.Radiobutton):
+  """A validated radio button"""
+
+  def __init__(self, *args, error_var=None, **kwargs):
+    super().__init__(*args, **kwargs)
+    self.error = error_var or tk.StringVar()
+    self.variable = kwargs.get("variable")
+    self.bind('<FocusOut>', self._focusout_validate)
+
+  def _focusout_validate(self, *_):
+    self.error.set('')
+    if not self.variable.get():
+      self.error.set('A value is required')
+
+  def trigger_focusout_validation(self):
+    self._focusout_validate()
+
+
 class BoundText(tk.Text):
   """A Text widget with a bound variable."""
 
   def __init__(self, *args, textvariable=None, **kwargs):
     super().__init__(*args, **kwargs)
     self._variable = textvariable
-    self._modifying = False
     if self._variable:
       # insert any default value
       self.insert('1.0', self._variable.get())
       self._variable.trace_add('write', self._set_content)
       self.bind('<<Modified>>', self._set_var)
 
-  def _clear_modified_flag(self):
-    # This also triggers a '<<Modified>>' Event
-    self.tk.call(self._w, 'edit', 'modified', 0)
-
   def _set_var(self, *_):
     """Set the variable to the text contents"""
-    if self._modifying:
-      return
-    self._modifying = True
-    # remove trailing newline from content
-    content = self.get('1.0', tk.END)[:-1]
-    self._variable.set(content)
-    self._clear_modified_flag()
-    self._modifying = False
+    if self.edit_modified():
+      content = self.get('1.0', 'end-1chars')
+      self._variable.set(content)
+      self.edit_modified(False)
 
   def _set_content(self, *_):
     """Set the text contents to the variable"""
-    if self._modifying:
-      return
-    self._modifying = True
     self.delete('1.0', tk.END)
     self.insert('1.0', self._variable.get())
-    self._modifying = False
 
 
 ###########################
@@ -322,7 +328,7 @@ class LabelInput(ttk.Frame):
   field_types = {
     FT.string: RequiredEntry,
     FT.string_list: ValidatedCombobox,
-    FT.short_string_list: ttk.Radiobutton,
+    FT.short_string_list: ValidatedRadio,
     FT.iso_date_string: DateEntry,
     FT.long_string: BoundText,
     FT.decimal: ValidatedSpinbox,
@@ -365,22 +371,25 @@ def __init__(
       self.label.grid(row=0, column=0, sticky=(tk.W + tk.E))
 
     # setup the variable
-    if input_class in (ttk.Checkbutton, ttk.Button, ttk.Radiobutton):
+    if input_class in (
+        ttk.Checkbutton, ttk.Button, ttk.Radiobutton, ValidatedRadio
+    ):
       input_args["variable"] = self.variable
     else:
       input_args["textvariable"] = self.variable
 
     # Setup the input
-    if input_class == ttk.Radiobutton:
+    if input_class in (ttk.Radiobutton, ValidatedRadio):
       # for Radiobutton, create one input per value
       self.input = tk.Frame(self)
       for v in input_args.pop('values', []):
-        button = ttk.Radiobutton(
-          self.input, value=v, text=v, **input_args)
+        button = input_class(
+          self.input, value=v, text=v, **input_args
+        )
         button.pack(side=tk.LEFT, ipadx=10, ipady=2, expand=True, fill='x')
-    else:
-      self.input = input_class(self, **input_args)
-
+      self.input.error = getattr(button, 'error')
+      self.input.trigger_focusout_validation = \
+        button._focusout_validate
     self.input.grid(row=1, column=0, sticky=(tk.W + tk.E))
     self.columnconfigure(0, weight=1)
 

Chapter07/ABQ_Data_Entry/docs/abq_data_entry_spec.rst

@@ -2,95 +2,106 @@
  ABQ Data Entry Program specification
 ======================================
 
-
 Description
 -----------
-The program is being created to minimize data entry errors for laboratory measurements.
+This program facilitates entry of laboratory observations
+into a CSV file.
 
-Functionality Required
-----------------------
+Requirements
+------------
 
-The program must:
+Functional Requirements:
 
-* allow all relevant, valid data to be entered, as per the field chart
-* append entered data to a CSV file
-  - The CSV file must have a filename of abq_data_record_CURRENTDATE.csv,
-  where CURRENTDATE is the date of the checks in ISO format (Year-month-day)
-  - The CSV file must have all the fields as per the chart
-* enforce correct datatypes per field
-* have inputs that:
+  * Allow all relevant, valid data to be entered,
+    as per the data dictionary.
+  * Append entered data to a CSV file:
+    - The CSV file must have a filename of
+    abq_data_record_CURRENTDATE.csv, where CURRENTDATE is the date
+    of the laboratory observations in ISO format (Year-month-day).
+    - The CSV file must include all fields.
+    listed in the data dictionary.
+    - The CSV headers will avoid cryptic abbreviations.
+  * Enforce correct datatypes per field.
+  * have inputs that:
     - ignore meaningless keystrokes
     - display an error if the value is invalid on focusout
     - display an error if a required field is empty on focusout
-* prevent saving the record when errors are present
+  * prevent saving the record when errors are present
 
-The program should try, whenever possible, to:
+Non-functional Requirements:
 
-* enforce reasonable limits on data entered
-* Auto-fill data
-* Suggest likely correct values
-* Provide a smooth and efficient workflow
+  * Enforce reasonable limits on data entered, per the data dict.
+  * Auto-fill data to save time.
+  * Suggest likely correct values.
+  * Provide a smooth and efficient workflow.
+  * Store data in a format easily understandable by Python.
 
 Functionality Not Required
 --------------------------
 
 The program does not need to:
 
-* Allow editing of data. This can be done in LibreOffice if necessary.
-* Allow deletion of data.
+  * Allow editing of data.
+  * Allow deletion of data.
+
+Users can perform both actions in LibreOffice if needed.
+
 
 Limitations
 -----------
 
 The program must:
 
-* Be efficiently operable by keyboard-only users.
-* Be accessible to color blind users.
-* Run on Debian Linux.
-* Run acceptably on a low-end PC.
+  * Be efficiently operable by keyboard-only users.
+  * Be accessible to color blind users.
+  * Run on Debian GNU/Linux.
+  * Run acceptably on a low-end PC.
 
 Data Dictionary
 ---------------
-+------------+----------+------+------------------+--------------------------+
-|Field       | Datatype | Units| Range            |Descripton                |
-+============+==========+======+==================+==========================+
-|Date        |Date      |      |                  |Date of record            |
-+------------+----------+------+------------------+--------------------------+
-|Time        |Time      |      |8:00, 12:00,      |Time period               |
-|            |          |      |16:00, or 20:00   |                          |
-+------------+----------+------+------------------+--------------------------+
-|Lab         |String    |      | A - C            |Lab ID                    |
-+------------+----------+------+------------------+--------------------------+
-|Technician  |String    |      |                  |Technician name           |
-+------------+----------+------+------------------+--------------------------+
-|Plot        |Int       |      | 1 - 20           |Plot ID                   |
-+------------+----------+------+------------------+--------------------------+
-|Seed        |String    |      |                  |Seed sample ID            |
-|sample      |          |      |                  |                          |
-+------------+----------+------+------------------+--------------------------+
-|Fault       |Bool      |      |                  |Fault on environmental    |
-|            |          |      |                  |sensor                    |
-+------------+----------+------+------------------+--------------------------+
-|Light       |Decimal   |klx   | 0 - 100          |Light at plot             |
-+------------+----------+------+------------------+--------------------------+
-|Humidity    |Decimal   |g/m³  | 0.5 - 52.0       |Abs humidity at plot      |
-+------------+----------+------+------------------+--------------------------+
-|Temperature |Decimal   |°C    | 4 - 40           |Temperature at plot       |
-+------------+----------+------+------------------+--------------------------+
-|Blossoms    |Int       |      | 0 - 1000         |Number of blossoms in plot|
-+------------+----------+------+------------------+--------------------------+
-|Fruit       |Int       |      | 0 - 1000         |Number of fruits in plot  |
-+------------+----------+------+------------------+--------------------------+
-|Plants      |Int       |      | 0 - 20           |Number of plants in plot  |
-+------------+----------+------+------------------+--------------------------+
-|Max height  |Decimal   |cm    | 0 - 1000         |Height of tallest plant in|
-|            |          |      |                  |plot                      |
-+------------+----------+------+------------------+--------------------------+
-|Min height  |Decimal   |cm    | 0 - 1000         |Height of shortest plant  |
-|            |          |      |                  |in plot                   |
-+------------+----------+------+------------------+--------------------------+
-|Median      |Decimal   |cm    | 0 - 1000         |Median height of plants in|
-|height      |          |      |                  |plot                      |
-+------------+----------+------+------------------+--------------------------+
-|Notes       |String    |      |                  |Miscellaneous notes       |
-+------------+----------+------+------------------+--------------------------+
++------------+--------+----+---------------+--------------------+
+|Field       | Type   |Unit| Valid Values  |Description         |
++============+========+====+===============+====================+
+|Date        |Date    |    |               |Date of record      |
++------------+--------+----+---------------+--------------------+
+|Time        |Time    |    |8:00, 12:00,   |Time period         |
+|            |        |    |16:00, or 20:00|                    |
++------------+--------+----+---------------+--------------------+
+|Lab         |String  |    | A - C         |Lab ID              |
++------------+--------+----+---------------+--------------------+
+|Technician  |String  |    |               |Technician name     |
++------------+--------+----+---------------+--------------------+
+|Plot        |Int     |    | 1 - 20        |Plot ID             |
++------------+--------+----+---------------+--------------------+
+|Seed        |String  |    | 6-character   |Seed sample ID      |
+|Sample      |        |    | string        |                    |
++------------+--------+----+---------------+--------------------+
+|Fault       |Bool    |    | True, False   |Environmental       |
+|            |        |    |               |sensor fault        |
++------------+--------+----+---------------+--------------------+
+|Light       |Decimal |klx | 0 - 100       |Light at plot       |
+|            |        |    |               |blank on fault      |
++------------+--------+----+---------------+--------------------+
+|Humidity    |Decimal |g/m³| 0.5 - 52.0    |Abs humidity at plot|
+|            |        |    |               |blank on fault      |
++------------+--------+----+---------------+--------------------+
+|Temperature |Decimal |°C  | 4 - 40        |Temperature at plot |
+|            |        |    |               |blank on fault      |
++------------+--------+----+---------------+--------------------+
+|Blossoms    |Int     |    | 0 - 1000      |No. blossoms in plot|
++------------+--------+----+---------------+--------------------+
+|Fruit       |Int     |    | 0 - 1000      |No. fruits in plot  |
++------------+--------+----+---------------+--------------------+
+|Plants      |Int     |    | 0 - 20        |No. plants in plot  |
++------------+--------+----+---------------+--------------------+
+|Max height  |Decimal |cm  | 0 - 1000      |Height of tallest   |
+|            |        |    |               |plant in plot       |
++------------+--------+----+---------------+--------------------+
+|Min height  |Decimal |cm  | 0 - 1000      |Height of shortest  |
+|            |        |    |               |plant in plot       |
++------------+--------+----+---------------+--------------------+
+|Median      |Decimal |cm  | 0 - 1000      |Median height of    |
+|height      |        |    |               |plants in plot      |
++------------+--------+----+---------------+--------------------+
+|Notes       |String  |    |               |Miscellaneous notes |
++------------+--------+----+---------------+--------------------+