Fixing pilot db access

* Very minor one, fixes to the way :class:`.Terminal` accesses the ``pilot_db.json`` file to use :attr:`.Terminal.pilots`
  property that makes a new pilot_db.json file if one doesn't exist, but otherwise loads the one that is found in
  ``prefs.get('PILOT_DB')``
* Reorganized :class:`.Terminal` source to group properties together & minor additions of type hinting
* Fixed some bad fallback behavior looking for files in old hardcoded default directories, eg. in the ye olde
  :func:`.utils.get_pilotdb`
* bump version to 0.3.5

Author: sneakers-the-rat

autopilot/__init__.py

@@ -1,2 +1,2 @@
 __author__  = 'Jonny Saunders <[email protected]>'
-__version__ = '0.3.4'
+__version__ = '0.3.5'

autopilot/core/gui.py

@@ -274,15 +274,8 @@ def update_db(self, **kwargs):
             if 'state' in val.keys():
                 del val['state']
 
-        try:
-            with open(prefs.get('PILOT_DB'), 'w') as pilot_file:
-                json.dump(self.pilots, pilot_file, indent=4, separators=(',', ': '))
-        except NameError:
-            try:
-                with open('/usr/autopilot/pilot_db.json', 'w') as pilot_file:
-                    json.dump(self.pilots, pilot_file, indent=4, separators=(',', ': '))
-            except IOError:
-                Exception('Couldnt update pilot db!')
+        with open(prefs.get('PILOT_DB'), 'w') as pilot_file:
+            json.dump(self.pilots, pilot_file, indent=4, separators=(',', ': '))
 
 ####################################
 # Control Panel Widgets

autopilot/core/terminal.py

@@ -2,6 +2,7 @@
 import json
 import sys
 import os
+from pathlib import Path
 
 import datetime
 import logging
@@ -108,7 +109,6 @@ class Terminal(QtWidgets.QMainWindow):
         node (:class:`~.networking.Net_Node`): Our Net_Node we use to communicate with our main networking object
         networking (:class:`~.networking.Terminal_Station`): Our networking object to communicate with the outside world
         subjects (dict): A dictionary mapping subject ID to :class:`~.subject.Subject` object.
-        pilots (dict): A dictionary mapping pilot ID to a list of its subjects, its IP, and any other pilot attributes.
         layout (:class:`QtWidgets.QGridLayout`): Layout used to organize widgets
         control_panel (:class:`~.gui.Control_Panel`): Control Panel to manage pilots and subjects
         data_panel (:class:`~.plots.Plot_Widget`): Plots for each pilot and subject.
@@ -130,7 +130,6 @@ def __init__(self):
 
         # data
         self.subjects = {}  # Dict of our open subject objects
-        self.pilots = None
 
         # gui
         self.layout = None
@@ -141,13 +140,12 @@ def __init__(self):
         self.data_panel = None
         self.logo = None
 
+        # property private attributes
+        self._pilots = None
+
         # logging
         self.logger = init_logger(self)
 
-        # Load pilots db as ordered dictionary
-        with open(prefs.get('PILOT_DB')) as pilot_file:
-            self.pilots = json.load(pilot_file, object_pairs_hook=odict)
-
         # Listen dictionary - which methods to call for different messages
         # Methods are spawned in new threads using handle_message
         self.listens = {
@@ -378,6 +376,91 @@ def reset_ui(self):
         self.setCentralWidget(self.widget)
         self.initUI()
 
+    ################
+    # Properties
+
+    @property
+    def pilots(self) -> odict:
+        """
+        A dictionary mapping pilot ID to its attributes, including a list of its subjects assigned to it, its IP, etc.
+
+        Returns:
+            dict: like ``self.pilots['pilot_id'] = {'subjects': ['subject_0', 'subject_1'], 'ip': '192.168.0.101'}``
+        """
+
+        # try to load, if none exists make one
+        if self._pilots is None:
+
+            pilot_db_fn = Path(prefs.get('PILOT_DB'))
+
+            # if pilot file doesn't exist, make blank one
+            if not pilot_db_fn.exists():
+                self.logger.warning(f'No pilot_db.json file was found at {pilot_db_fn}, creating a new one')
+                self._pilots = odict()
+                with open(pilot_db_fn, 'w') as pilot_file:
+                    json.dump(self._pilots, pilot_file)
+
+            # otherwise, try to load it
+            else:
+                try:
+                    # Load pilots db as ordered dictionary
+                    with open(pilot_db_fn, 'r') as pilot_file:
+                        self._pilots = json.load(pilot_file, object_pairs_hook=odict)
+                except Exception as e:
+                    self.logger.exception((f"Exception opening pilot_db.json file at {pilot_db_fn}, got exception: {e}.\n",
+                                           "Not proceeding to prevent possibly overwriting corrupt pilot_db.file"))
+                    raise e
+
+        return self._pilots
+
+
+    @property
+    def protocols(self) -> list:
+        """
+        List of protocol names available in ``PROTOCOLDIR``
+
+        Returns:
+            list: list of protocol names in ``prefs.get('PROTOCOLDIR')``
+        """
+        # get list of protocol files
+        protocols = os.listdir(prefs.get('PROTOCOLDIR'))
+        protocols = [os.path.splitext(p)[0] for p in protocols if p.endswith('.json')]
+        return protocols
+
+    @property
+    def subject_protocols(self) -> dict:
+        """
+
+        Returns:
+            subject_protocols (dict): a dictionary of subjects: [protocol, step]
+        """
+        # get subjects and current protocols
+        subjects = self.subject_list
+        subjects_protocols = {}
+        for subject in subjects:
+            if subject not in self.subjects.keys():
+                self.subjects[subject] = Subject(subject)
+
+            subjects_protocols[subject] = [self.subjects[subject].protocol_name, self.subjects[subject].step]
+
+        return subjects_protocols
+
+    @property
+    def subject_list(self) -> list:
+        """
+        Get a list of all subject IDs
+
+        Returns:
+            list: list of all subject IDs present in :attr:`.Terminal.pilots`
+        """
+        subjects = []
+        for pilot, vals in self.pilots.items():
+            subjects.extend(vals['subjects'])
+
+        # use sets to get a unique list
+        subjects = list(set(subjects))
+
+        return subjects
 
     ##########################3
     # Listens & inter-object methods
@@ -626,23 +709,6 @@ def new_protocol(self):
                 with open(protocol_file, 'w') as pfile_open:
                     json.dump(save_steps, pfile_open, indent=4, separators=(',', ': '), sort_keys=True)
 
-    @property
-    def subject_list(self):
-        """
-        Get a list of all subject IDs
-
-        Returns:
-            list: list of all subject IDs present in :attr:`.Terminal.pilots`
-        """
-        subjects = []
-        for pilot, vals in self.pilots.items():
-            subjects.extend(vals['subjects'])
-
-        # use sets to get a unique list
-        subjects = list(set(subjects))
-
-        return subjects
-
     def subject_weights(self):
         """
         Gets recent weights from all :attr:`~.Terminal.subjects` and
@@ -692,36 +758,6 @@ def update_protocols(self):
         msgbox.setDetailedText("\n".join(sorted(updated_subjects)))
         msgbox.exec_()
 
-    @property
-    def protocols(self):
-        """
-        Returns:
-            list: list of protocol files in ``prefs.get('PROTOCOLDIR')``
-        """
-        # get list of protocol files
-        protocols = os.listdir(prefs.get('PROTOCOLDIR'))
-        protocols = [os.path.splitext(p)[0] for p in protocols if p.endswith('.json')]
-        return protocols
-
-    @property
-    def subject_protocols(self):
-        """
-
-        Returns:
-            subject_protocols (dict): a dictionary of subjects: [protocol, step]
-        """
-        # get subjects and current protocols
-        subjects = self.subject_list
-        subjects_protocols = {}
-        for subject in subjects:
-            if subject not in self.subjects.keys():
-                self.subjects[subject] = Subject(subject)
-
-            subjects_protocols[subject] = [self.subjects[subject].protocol_name, self.subjects[subject].step]
-
-        return subjects_protocols
-
-
     def reassign_protocols(self):
         """
         Batch reassign protocols and steps.

autopilot/core/utils.py

@@ -7,6 +7,7 @@
 except ImportError:
     pass
 
+from collections import OrderedDict as odict
 import json
 import pandas as pd
 from scipy.stats import linregress
@@ -165,23 +166,23 @@ def load_pilotdb(file_name=None, reverse=False):
     Try to load the file_db
 
     Args:
-        reverse:
-        file_name:
+        reverse (bool): Return inverted pilot db mapping subjects: pilots (default False)
+        file_name (str): Path of ``pilot_db.json``, if None, use ``prefs.get('PILOT_DB')``
 
     Returns:
-
+        :class:`collections.OrderedDict` : pilot_db.json or reversed pilot_db
     """
 
     if file_name is None:
-        file_name = '/usr/autopilot/pilot_db.json'
+        file_name = prefs.get('PILOT_DB')
 
     with open(file_name) as pilot_file:
-        pilot_db = json.load(pilot_file)
+        pilot_db = json.load(pilot_file, object_pairs_hook=odict)
 
     if reverse:
         # simplify pilot db
-        pilot_db = {k: v['subjects'] for k, v in pilot_db.items()}
-        pilot_dict = {}
+        pilot_db = odict({k: v['subjects'] for k, v in pilot_db.items()})
+        pilot_dict = odict()
         for pilot, subjectlist in pilot_db.items():
             for ms in subjectlist:
                 pilot_dict[ms] = pilot

docs/changelog/v0.3.0.rst

@@ -1,5 +1,18 @@
 .. _changelog_v030:
 
+v0.3.5 (February 22, 2021)
+--------------------------
+
+Bugfixes
+~~~~~~~~
+
+* Very minor one, fixes to the way :class:`.Terminal` accesses the ``pilot_db.json`` file to use :attr:`.Terminal.pilots`
+  property that makes a new pilot_db.json file if one doesn't exist, but otherwise loads the one that is found in
+  ``prefs.get('PILOT_DB')``
+* Reorganized :class:`.Terminal` source to group properties together & minor additions of type hinting
+* Fixed some bad fallback behavior looking for files in old hardcoded default directories, eg. in the ye olde
+  :func:`.utils.get_pilotdb`
+
 v0.3.4 (December 13, 2020)
 ---------------------------
 

docs/notes/building.txt

@@ -1,7 +1,7 @@
 deployment
 - write docs
 - write changelog
-- bump version in setup.py
+- bump version in __init__.py
 
 - do PR
 - merge