Add chapter 9 code

Author: alandmoore

Chapter09/ABQ_Data_Entry/.gitignore

@@ -0,0 +1,2 @@
+*.pyc
+__pycache__/

Chapter09/ABQ_Data_Entry/README.rst

@@ -0,0 +1,43 @@
+============================
+ ABQ Data Entry Application
+============================
+
+Description
+===========
+
+This program provides a data entry form for ABQ Agrilabs laboratory data.
+
+Features
+--------
+
+  * Provides a validated entry form to ensure correct data
+  * Stores data to ABQ-format CSV files
+  * Auto-fills form fields whenever possible
+
+Authors
+=======
+
+Alan D Moore, 2021
+
+Requirements
+============
+
+  * Python 3.7 or higher
+  * Tkinter
+
+Usage
+=====
+
+To start the application, run::
+
+  python3 ABQ_Data_Entry/abq_data_entry.py
+
+
+General Notes
+=============
+
+The CSV file will be saved to your current directory in the format
+``abq_data_record_CURRENTDATE.csv``, where CURRENTDATE is today's date in ISO format.
+
+This program only appends to the CSV file.  You should have a spreadsheet program
+installed in case you need to edit or check the file.

Chapter09/ABQ_Data_Entry/abq_data_entry.py

@@ -0,0 +1,4 @@
+from abq_data_entry.application import Application
+
+app = Application()
+app.mainloop()

Chapter09/ABQ_Data_Entry/abq_data_entry/__init__.py

@@ -0,0 +1,266 @@
+"""The application/controller class for ABQ Data Entry"""
+
+import tkinter as tk
+from tkinter import ttk
+from tkinter import messagebox
+from tkinter import filedialog
+from tkinter import font
+
+from . import views as v
+from . import models as m
+from .mainmenu import MainMenu
+from . import images
+
+class Application(tk.Tk):
+  """Application root window"""
+
+
+  def __init__(self, *args, **kwargs):
+    super().__init__(*args, **kwargs)
+
+    # Hide window while GUI is built
+    self.withdraw()
+
+    # Authenticate
+    if not self._show_login():
+      self.destroy()
+      return
+
+    # show the window
+    self.deiconify()
+
+   # Create model
+    self.model = m.CSVModel()
+
+    # Load settings
+    # self.settings = {
+    #   'autofill date': tk.BooleanVar(),
+    #   'autofill sheet data': tk.BoleanVar()
+    # }
+    self.settings_model = m.SettingsModel()
+    self._load_settings()
+
+    self.inserted_rows = []
+    self.updated_rows = []
+
+    # Begin building GUI
+    self.title("ABQ Data Entry Application")
+    self.columnconfigure(0, weight=1)
+
+    # Set taskbar icon
+    self.taskbar_icon = tk.PhotoImage(file=images.ABQ_LOGO_64)
+    self.iconphoto(True, self.taskbar_icon)
+
+    # Create the menu
+    menu = MainMenu(self, self.settings)
+    self.config(menu=menu)
+    event_callbacks = {
+      '<<FileSelect>>': self._on_file_select,
+      '<<FileQuit>>': lambda _: self.quit(),
+      '<<ShowRecordlist>>': self._show_recordlist,
+      '<<NewRecord>>': self._new_record,
+
+    }
+    for sequence, callback in event_callbacks.items():
+      self.bind(sequence, callback)
+
+    # new for ch9
+    self.logo = tk.PhotoImage(file=images.ABQ_LOGO_32)
+    ttk.Label(
+      self,
+      text="ABQ Data Entry Application",
+      font=("TkDefaultFont", 16),
+      image=self.logo,
+      compound=tk.LEFT
+    ).grid(row=0)
+
+    # The notebook
+    self.notebook = ttk.Notebook(self)
+    self.notebook.enable_traversal()
+    self.notebook.grid(row=1, padx=10, sticky='NSEW')
+
+    # The data record form
+    self.recordform_icon = tk.PhotoImage(file=images.FORM_ICON)
+    self.recordform = v.DataRecordForm(self, self.model, self.settings)
+    self.notebook.add(
+        self.recordform, text='Entry Form',
+        image=self.recordform_icon, compound=tk.LEFT
+    )
+    self.recordform.bind('<<SaveRecord>>', self._on_save)
+
+
+    # The data record list
+    self.recordlist_icon = tk.PhotoImage(file=images.LIST_ICON)
+    self.recordlist = v.RecordList(
+      self, self.inserted_rows, self.updated_rows
+    )
+    self.notebook.insert(
+        0, self.recordlist, text='Records',
+        image=self.recordlist_icon, compound=tk.LEFT
+    )
+    self._populate_recordlist()
+    self.recordlist.bind('<<OpenRecord>>', self._open_record)
+
+
+    self._show_recordlist()
+
+    # status bar
+    self.status = tk.StringVar()
+    self.statusbar = ttk.Label(self, textvariable=self.status)
+    self.statusbar.grid(sticky=(tk.W + tk.E), row=3, padx=10)
+
+
+    self.records_saved = 0
+
+
+  def _on_save(self, *_):
+    """Handles file-save requests"""
+
+    # Check for errors first
+
+    errors = self.recordform.get_errors()
+    if errors:
+      self.status.set(
+        "Cannot save, error in fields: {}"
+        .format(', '.join(errors.keys()))
+      )
+      message = "Cannot save record"
+      detail = "The following fields have errors: \n  * {}".format(
+        '\n  * '.join(errors.keys())
+      )
+      messagebox.showerror(
+        title='Error',
+        message=message,
+        detail=detail
+      )
+      return False
+
+    data = self.recordform.get()
+    rownum = self.recordform.current_record
+    self.model.save_record(data, rownum)
+    if rownum is not None:
+      self.updated_rows.append(rownum)
+    else:
+      rownum = len(self.model.get_all_records()) -1
+      self.inserted_rows.append(rownum)
+    self.records_saved += 1
+    self.status.set(
+      "{} records saved this session".format(self.records_saved)
+    )
+    self.recordform.reset()
+    self._populate_recordlist()
+
+  def _on_file_select(self, *_):
+    """Handle the file->select action"""
+
+    filename = filedialog.asksaveasfilename(
+      title='Select the target file for saving records',
+      defaultextension='.csv',
+      filetypes=[('CSV', '*.csv *.CSV')]
+    )
+    if filename:
+      self.model = m.CSVModel(filename=filename)
+      self.inserted_rows.clear()
+      self.updated_rows.clear()
+      self._populate_recordlist()
+
+  @staticmethod
+  def _simple_login(username, password):
+    """A basic authentication backend with a hardcoded user and password"""
+    return username == 'abq' and password == 'Flowers'
+
+  def _show_login(self):
+    """Show login dialog and attempt to login"""
+    error = ''
+    title = "Login to ABQ Data Entry"
+    while True:
+      login = v.LoginDialog(self, title, error)
+      if not login.result:  # User canceled
+        return False
+      username, password = login.result
+      if self._simple_login(username, password):
+        return True
+      error = 'Login Failed' # loop and redisplay
+
+  def _load_settings(self):
+    """Load settings into our self.settings dict."""
+
+    vartypes = {
+      'bool': tk.BooleanVar,
+      'str': tk.StringVar,
+      'int': tk.IntVar,
+      'float': tk.DoubleVar
+    }
+
+    # create our dict of settings variables from the model's settings.
+    self.settings = dict()
+    for key, data in self.settings_model.fields.items():
+      vartype = vartypes.get(data['type'], tk.StringVar)
+      self.settings[key] = vartype(value=data['value'])
+
+    # put a trace on the variables so they get stored when changed.
+    for var in self.settings.values():
+      var.trace_add('write', self._save_settings)
+
+    # update font settings after loading them
+    self._set_font()
+    self.settings['font size'].trace_add('write', self._set_font)
+    self.settings['font family'].trace_add('write', self._set_font)
+
+    # process theme
+    style = ttk.Style()
+    theme = self.settings.get('theme').get()
+    if theme in style.theme_names():
+      style.theme_use(theme)
+
+  def _save_settings(self, *_):
+    """Save the current settings to a preferences file"""
+
+    for key, variable in self.settings.items():
+      self.settings_model.set(key, variable.get())
+    self.settings_model.save()
+
+  def _show_recordlist(self, *_):
+    """Show the recordform"""
+    self.notebook.select(self.recordlist)
+
+  def _populate_recordlist(self):
+    try:
+      rows = self.model.get_all_records()
+    except Exception as e:
+      messagebox.showerror(
+        title='Error',
+        message='Problem reading file',
+        detail=str(e)
+      )
+    else:
+      self.recordlist.populate(rows)
+
+  def _new_record(self, *_):
+    """Open the record form with a blank record"""
+    self.recordform.load_record(None, None)
+    self.notebook.select(self.recordform)
+
+
+  def _open_record(self, *_):
+    """Open the Record selected recordlist id in the recordform"""
+    rowkey = self.recordlist.selected_id
+    try:
+      record = self.model.get_record(rowkey)
+    except Exception as e:
+      messagebox.showerror(
+        title='Error', message='Problem reading file', detail=str(e)
+      )
+      return
+    self.recordform.load_record(rowkey, record)
+    self.notebook.select(self.recordform)
+
+  # new chapter 9
+  def _set_font(self, *_):
+    """Set the application's font"""
+    font_size = self.settings['font size'].get()
+    font_family = self.settings['font family'].get()
+    font_names = ('TkDefaultFont', 'TkMenuFont', 'TkTextFont')
+    for font_name in font_names:
+      tk_font = font.nametofont(font_name)
+      tk_font.config(size=font_size, family=font_family)

Chapter09/ABQ_Data_Entry/abq_data_entry/application.py

@@ -0,0 +1,12 @@
+"""Global constants and classes needed by other modules in ABQ Data Entry"""
+from enum import Enum, auto
+
+class FieldTypes(Enum):
+  string = auto()
+  string_list = auto()
+  short_string_list = auto()
+  iso_date_string = auto()
+  long_string = auto()
+  decimal = auto()
+  integer = auto()
+  boolean = auto()

Chapter09/ABQ_Data_Entry/abq_data_entry/constants.py

@@ -0,0 +1,20 @@
+from pathlib import Path
+
+# This gives us the parent directory of this file (__init__.py)
+IMAGE_DIRECTORY = Path(__file__).parent
+
+ABQ_LOGO_16 = IMAGE_DIRECTORY / 'abq_logo-16x10.png'
+ABQ_LOGO_32 = IMAGE_DIRECTORY / 'abq_logo-32x20.png'
+ABQ_LOGO_64 = IMAGE_DIRECTORY / 'abq_logo-64x40.png'
+
+# PNG icons
+
+SAVE_ICON = IMAGE_DIRECTORY / 'file-2x.png'
+RESET_ICON = IMAGE_DIRECTORY / 'reload-2x.png'
+LIST_ICON = IMAGE_DIRECTORY / 'list-2x.png'
+FORM_ICON = IMAGE_DIRECTORY / 'browser-2x.png'
+
+
+# BMP icons
+QUIT_BMP = IMAGE_DIRECTORY / 'x-2x.xbm'
+ABOUT_BMP = IMAGE_DIRECTORY / 'question-mark-2x.xbm'