added chapter 5 code

Author: alandmoore

Chapter05/DateEntry.py

@@ -0,0 +1,61 @@
+import tkinter as tk
+from tkinter import ttk
+from datetime import datetime
+
+class DateEntry(ttk.Entry):
+  """An Entry for ISO-style dates (Year-month-day)"""
+
+  def __init__(self, parent, *args, **kwargs):
+    super().__init__(parent, *args, **kwargs)
+    self.configure(
+      validate='all',
+      validatecommand=(self.register(self._validate),  '%S', '%i', '%V', '%d'),
+      invalidcommand=(self.register(self._on_invalid), '%V')
+    )
+    self.error = tk.StringVar()
+
+  def _toggle_error(self, error=''):
+    self.error.set(error)
+    if error:
+      self.config(foreground='red')
+    else:
+      self.config(foreground='black')
+
+  def _validate(self, char, index, event, action):
+
+    # reset error state
+    self._toggle_error()
+    valid = True
+
+    # ISO dates only need digits and hyphens
+    if event == 'key':
+      if action == '0':
+        valid = True
+      elif index in ('0', '1', '2', '3', '5', '6', '8', '9'):
+        valid = char.isdigit()
+      elif index in ('4', '7'):
+        valid = char == '-'
+      else:
+        valid = False
+    elif event == 'focusout':
+      try:
+        datetime.strptime(self.get(), '%Y-%m-%d')
+      except ValueError:
+        valid = False
+    return valid
+
+  def _on_invalid(self, event):
+    if event != 'key':
+      self._toggle_error('Not a valid date')
+
+if __name__ == '__main__':
+  root = tk.Tk()
+  entry = DateEntry(root)
+  entry.pack()
+  ttk.Label(
+      textvariable=entry.error, foreground='red'
+  ).pack()
+
+  # add this so we can unfocus the DateEntry
+  ttk.Entry(root).pack()
+  root.mainloop()

Chapter05/MixinExample.py

@@ -0,0 +1,34 @@
+"""This example shows the use of a mixin class"""
+
+class Fruit():
+
+  _taste = 'sweet'
+
+  def taste(self):
+    print(f'It tastes {self._taste}')
+
+class PeelableMixin():
+
+  def __init__(self, *args, **kwargs):
+    super().__init__(*args, **kwargs)
+    self._peeled = False
+
+  def peel(self):
+    self._peeled = True
+
+  def taste(self):
+    if not self._peeled:
+      print('I will peel it first')
+      self.peel()
+    super().taste()
+
+class Plantain(PeelableMixin, Fruit):
+
+  _taste = 'starchy'
+
+  def peel(self):
+    print('It has a tough peel!')
+    super().peel()
+
+plantain = Plantain()
+plantain.taste()

Chapter05/abq_data_entry_spec.rst

@@ -0,0 +1,96 @@
+======================================
+ ABQ Data Entry Program specification
+======================================
+
+
+Description
+-----------
+The program is being created to minimize data entry errors for laboratory measurements.
+
+Functionality Required
+----------------------
+
+The program must:
+
+* 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:
+    - 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
+
+The program should try, whenever possible, to:
+
+* enforce reasonable limits on data entered
+* Auto-fill data
+* Suggest likely correct values
+* Provide a smooth and efficient workflow
+
+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.
+
+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.
+
+Data Dictionary
+---------------
++------------+----------+------+-------------+------------------------+
+|Field       | Datatype | Units| Range       |Descripton              |
++============+==========+======+=============+========================+
+|Date        |Date      |      |             |Date of record          |
++------------+----------+------+-------------+------------------------+
+|Time        |Time      |      |8:00, 12:00, |Time period             |
+|            |          |      |16:00, 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    |Num of blossoms in plot |
++------------+----------+------+-------------+------------------------+
+|Fruit       |Int       |      | 0 - 1000    |Num of fruits in plot   |
++------------+----------+------+-------------+------------------------+
+|Plants      |Int       |      | 0 - 20      |Num 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        |
+|height      |          |      |             |plants in plot          |
++------------+----------+------+-------------+------------------------+
+|Notes       |String    |      |             |Miscellaneous notes     |
++------------+----------+------+-------------+------------------------+