test/data/vclamp_jpk/README: Document sample versions

[hooke.git] / hooke / command_stack.py

diff --git a/hooke/command_stack.py b/hooke/command_stack.py
index 202e599a7ffafcaf703dd48768016c04401c7cf6..1307a01f8a011bae83020ab2fe4e66f4c21176fc 100644 (file)
--- a/hooke/command_stack.py
+++ b/hooke/command_stack.py
@@ -1,23 +1,32 @@
-# Copyright (C) 2010-2011 W. Trevor King <wking@drexel.edu>
+# Copyright (C) 2010-2012 W. Trevor King <wking@tremily.us>
 #
 # 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 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.
+# 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/>.
+# You should have received a copy of the GNU Lesser General Public License
+# along with Hooke.  If not, see <http://www.gnu.org/licenses/>.
 
 """The ``command_stack`` module provides tools for managing and
 executing stacks of :class:`~hooke.engine.CommandMessage`\s.
+
+In experiment analysis, the goal is to construct a
+:class:`~hooke.command_stack.CommandStack` that starts with your raw
+experiment data and ends with your analyzed results.  These
+:class:`~hooke.command_stack.CommandStack`\s are stored in your
+:class:`~hooke.playlist.FilePlaylist`, so they are saved to disk with
+the analysis results.  This means you will always have a record of
+exactly how you processed the raw data to produce your analysis
+results, which makes it easy to audit your approach or go back and
+reanalyze older data.
 """
 
 import os
@@ -42,7 +51,7 @@ class CommandStack (list):
 
     >>> def execute_cmd(hooke, command_message, stack=None):
     ...     cm = command_message
-    ...     print 'EXECUTE', cm.command, cm.arguments
+    ...     print('EXECUTE {} {}'.format(cm.command, cm.arguments))
     >>> c.execute_command = execute_cmd
 
     >>> c.execute(hooke=None)  # doctest: +ELLIPSIS
@@ -72,7 +81,7 @@ class CommandStack (list):
     >>> c.execute_command(hooke=None, command_message=cm)
     EXECUTE CommandC {'param': 'E'}
     >>> c.append(cm)
-    >>> print [repr(cm) for cm in c]  # doctest: +NORMALIZE_WHITESPACE
+    >>> print([repr(cm) for cm in c])  # doctest: +NORMALIZE_WHITESPACE
     ['<CommandMessage CommandA {param: A}>',
      '<CommandMessage CommandB {param: B}>',
      '<CommandMessage CommandA {param: C}>',
@@ -104,8 +113,8 @@ class CommandStack (list):
     >>> import pickle
     >>> s = pickle.dumps(c)
     >>> z = pickle.loads(s)
-    >>> print '\\n'.join([repr(cm) for cm in c]
-    ...     )  # doctest: +NORMALIZE_WHITESPACE,
+    >>> print('\\n'.join([repr(cm) for cm in c]))
+    ... # doctest: +NORMALIZE_WHITESPACE
     <CommandMessage CommandA {param: A}>
     <CommandMessage CommandB {param: B}>
     <CommandMessage CommandA {param: C}>
@@ -118,7 +127,7 @@ class CommandStack (list):
        <CommandMessage CommandB {param: D}>,
        <CommandMessage CommandC {param: E}>]}>
     >>> import yaml
-    >>> print yaml.dump(c)  # doctest: +REPORT_UDIFF
+    >>> print(yaml.dump(c))  # doctest: +REPORT_UDIFF
     !!python/object/new:hooke.command_stack.CommandStack
     listitems:
     - !!python/object:hooke.engine.CommandMessage
@@ -172,14 +181,14 @@ class CommandStack (list):
     There is also a convenience function for clearing the stack.
 
     >>> c.clear()
-    >>> print [repr(cm) for cm in c]
+    >>> print([repr(cm) for cm in c])
     []
 
     YAMLize a curve argument.
 
     >>> from .curve import Curve
     >>> c.append(CommandMessage('curve info', {'curve': Curve(path=None)}))
-    >>> print yaml.dump(c)  # doctest: +REPORT_UDIFF
+    >>> print(yaml.dump(c))  # doctest: +REPORT_UDIFF
     !!python/object/new:hooke.command_stack.CommandStack
     listitems:
     - !!python/object:hooke.engine.CommandMessage
@@ -297,7 +306,7 @@ class FileCommandStack (CommandStack):
         >>> c.append(CommandMessage('CommandB', {'param':'B'}))
         >>> c.append(CommandMessage('CommandA', {'param':'C'}))
         >>> c.append(CommandMessage('CommandB', {'param':'D'}))
-        >>> print c.flatten()
+        >>> print(c.flatten())
         - arguments: {param: A}
           command: CommandA
         - arguments: {param: B}
@@ -330,7 +339,7 @@ class FileCommandStack (CommandStack):
         ... '''
         >>> c = FileCommandStack()
         >>> c.from_string(string)
-        >>> print [repr(cm) for cm in c]  # doctest: +NORMALIZE_WHITESPACE
+        >>> print([repr(cm) for cm in c])  # doctest: +NORMALIZE_WHITESPACE
         ['<CommandMessage CommandA {param: A}>',
          '<CommandMessage CommandB {param: B}>',
          '<CommandMessage CommandA {param: C}>',