Broke out Hooke.run and Hooke.run_lines into HookeRunner.

[hooke.git] / hooke / hooke.py

diff --git a/hooke/hooke.py b/hooke/hooke.py
index ed6f8ba867edd5efc621a00e552f1e0da7b8ca2a..e8a00506602665605fb43193ff2bb4ad3150b805 100644 (file)
--- a/hooke/hooke.py
+++ b/hooke/hooke.py
@@ -1,15 +1,32 @@
-#!/usr/bin/env python
-
-'''
-Hooke - A force spectroscopy review & analysis tool.
-
-A free, open source data analysis platform
-
-COPYRIGHT
-'''
+# Copyright (C) 2008-2010 Fabrizio Benedetti
+#                         Massimo Sandal <devicerandom@gmail.com>
+#                         Rolf Schmidt <rschmidt@alcor.concordia.ca>
+#                         W. Trevor King <wking@drexel.edu>
+#
+# This file is part of Hooke.
+#
+# Hooke is free software: you can redistribute it and/or
+# modify it under the terms of the GNU Lesser General Public
+# License as published by the Free Software Foundation, either
+# version 3 of the License, or (at your option) any later version.
+#
+# Hooke is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public
+# License along with Hooke.  If not, see
+# <http://www.gnu.org/licenses/>.
+
+"""Hooke - A force spectroscopy review & analysis tool.
+"""
 
 import multiprocessing
+import optparse
+import os.path
 import unittest
+import sys
 
 from . import engine as engine
 from . import config as config_mod
@@ -56,44 +73,87 @@ class Hooke (object):
     def close(self):
         self.config.write() # Does not preserve original comments
 
-    def run(self):
+class HookeRunner (object):
+    def run(self, hooke):
         """Run Hooke's main execution loop.
 
         Spawns a :class:`hooke.engine.CommandEngine` subprocess and
         then runs the UI, rejoining the `CommandEngine` process after
         the UI exits.
         """
+        ui_to_command,command_to_ui,command = self._setup_run(hooke)
+        try:
+            self.ui.run(hooke.commands, ui_to_command, command_to_ui)
+        finally:
+            hooke = self._cleanup_run(ui_to_command, command_to_ui, command)
+        return hooke
+
+    def run_lines(self, hooke, lines):
+        """Run the pre-set commands `lines` with the "command line" UI.
+
+        Allows for non-interactive sessions that are otherwise
+        equivalent to :meth:'.run'.
+        """
+        cmdline = ui.load_ui(hooke.config, 'command line')
+        ui_to_command,command_to_ui,command = self._setup_run(hooke)
+        try:
+            cmdline.run_lines(
+                hooke.commands, ui_to_command, command_to_ui, lines)
+        finally:
+            hooke = self._cleanup_run(ui_to_command, command_to_ui, command)
+        return hooke
+
+    def _setup_run(self, hooke):
         ui_to_command = multiprocessing.Queue()
         command_to_ui = multiprocessing.Queue()
-        command = multiprocessing.Process(
-            target=self.command.run, args=(self, ui_to_command, command_to_ui))
+        manager = multiprocessing.Manager()        
+        command = multiprocessing.Process(name='command engine',
+            target=hooke.command.run, args=(hooke, ui_to_command, command_to_ui))
         command.start()
+        return (ui_to_command, command_to_ui, command)
+
+    def _cleanup_run(self, ui_to_command, command_to_ui, command):
+        ui_to_command.put(ui.CloseEngine())
+        hooke = command_to_ui.get()
+        assert isinstance(hooke, Hooke)
+        command.join()
+        return hooke
+
+
+def main():
+    p = optparse.OptionParser()
+    p.add_option(
+        '-s', '--script', dest='script', metavar='FILE',
+        help='Script of command line Hooke commands to run.')
+    p.add_option(
+        '-c', '--command', dest='commands', metavar='COMMAND',
+        action='append', default=[],
+        help='Add a command line Hooke command to run.')
+    options,arguments = p.parse_args()
+    if len(arguments) > 0:
+        print >> sys.stderr, 'Too many arguments to %s: %d > 0' \
+            % (sys.argv[0], len(arguments))
+        print >> sys.stderr, p.help()
+        sys.exit(1)
+
+    hooke = Hooke(debug=__debug__)
+    runner = HookeRunner()
+
+    if options.script != None:
+        f = open(os.path.expanduser(options.script), 'r')
+        options.commands.extend(f.readlines())
+        f.close
+    if len(options.commands) > 0:
         try:
-            self.ui.run(self.commands, ui_to_command, command_to_ui)
+            hooke = runner.run_lines(hooke, options.commands)
         finally:
-            ui_to_command.put(ui.CloseEngine())
-            command.join()
+            hooke.close()
+        sys.exit(0)
 
-def main():
-    app = Hooke(debug=__debug__)
     try:
-        app.run()
+        hooke = runner.run(hooke)
     finally:
-        app.close()
-
-class TestHooke (unittest.TestCase):
-    def test_queue_safe(self):
-        """Ensure :class:`Hooke` is :class:`multiprocessing.Queue`-safe.
-        """
-        from multiprocessing import Queue
-        q = Queue()
-        a = Hooke()
-        q.put(a)
-        b = q.get(a)
-        for attribute_name in dir(a):
-            a_attr = getattr(a, attribute_name)
-            b_attr = getattr(b, attribute_name)
-            self.failUnless(a_attr == b_attr)
+        hooke.close()
 
 if __name__ == '__main__':
     main()