Added gui.panel.output for displaying text output
[hooke.git] / hooke / config.py
index 03da0c9cb0ab7c1f4859f22b7e1be33f9fce9bda..6d9ccebaea40f448b018bbc1ef6eec54be317ba1 100644 (file)
@@ -1,13 +1,24 @@
-#!/usr/bin/env python
-# -*- coding: utf-8 -*-
-
-'''
-config.py
-
-Configuration defaults, read/write, and template file creation for Hooke.
-
-COPYRIGHT
-'''
+# Copyright (C) 2010 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/>.
+
+"""Configuration defaults, read/write, and template file creation for
+Hooke.
+"""
 
 import ConfigParser as configparser
 import os.path
@@ -34,7 +45,7 @@ class Setting (object):
     def __init__(self, section, option=None, value=None, help=None, wrap=True):
         self.section = section
         self.option = option
-        self.value = value
+        self.value = str(value)
         self.help = help
         self.wrap = wrap
 
@@ -58,9 +69,11 @@ class Setting (object):
             if self.wrap == True:
                 if wrapper == None:
                     wrapper = textwrap.TextWrapper(
-                        initial_indent="# ",
-                        subsequent_indent="# ")
+                        initial_indent='# ',
+                        subsequent_indent='# ')
                 text = wrapper.fill(text)
+            else:
+                text = '# ' + '\n# '.join(text.splitlines())
             fp.write(text.rstrip()+'\n')
         if self.is_section():
             fp.write("[%s]\n" % self.section)
@@ -69,52 +82,32 @@ class Setting (object):
                                     str(value).replace('\n', '\n\t')))
 
 DEFAULT_SETTINGS = [
-    Setting('display', help='Control display appearance: colour, ???, etc.'),
-    Setting('display', 'colour_ext', 'None', help=None),
-    Setting('display', 'colour_ret', 'None', help=None),
-    Setting('display', 'ext', '1', help=None),
-    Setting('display', 'ret', '1', help=None),
-
-    Setting('display', 'correct', '1', help=None),
-    Setting('display', 'colout_correct', 'None', help=None),
-    Setting('display', 'contact_point', '0', help=None),
-    Setting('display', 'medfilt', '0', help=None),
-
-    Setting('display', 'xaxes', '0', help=None),
-    Setting('display', 'yaxes', '0', help=None),
-    Setting('display', 'flatten', '1', help=None),
-
-    Setting('conditions', 'temperature', '301', help=None),
-
-    Setting('fitting', 'auto_fit_points', '50', help=None),
-    Setting('fitting', 'auto_slope_span', '20', help=None),
-    Setting('fitting', 'auto_delta_force', '1-', help=None),
-    Setting('fitting', 'auto_fit_nm', '5', help=None),
-    Setting('fitting', 'auto_min_p', '0.005', help=None),
-    Setting('fitting', 'auto_max_p', '10', help=None),
-
-    Setting('?', 'baseline_clicks', '0', help=None),
-    Setting('fitting', 'auto_left_baseline', '20', help=None),
-    Setting('fitting', 'auto_right_baseline', '20', help=None),
-    Setting('fitting', 'force_multiplier', '1', help=None),
-    
-    Setting('display', 'fc_showphase', '0', help=None),
-    Setting('display', 'fc_showimposed', '0', help=None),
-    Setting('display', 'fc_interesting', '0', help=None),
-    Setting('?', 'tccd_threshold', '0', help=None),
-    Setting('?', 'tccd_coincident', '0', help=None),
-    Setting('display', '', '', help=None),
-    Setting('display', '', '', help=None),
-
-    Setting('filesystem', 'filterindex', '0', help=None),
-    Setting('filesystem', 'filters',
-            "Playlist files (*.hkp)|*.hkp|Text files (*.txt)|*.txt|All files (*.*)|*.*')",
-            help=None),
-    Setting('filesystem', 'workdir', 'test',
-            help='\n'.join(['# Substitute your work directory',
-                            '#workdir = D:\hooke']),
-            wrap=False),
-    Setting('filesystem', 'playlist', 'test.hkp', help=None),
+    Setting('conditions', help='Default environmental conditions in case they are not specified in the force curve data.'),
+    Setting('conditions', 'temperature', '301', help='Temperature in Kelvin'),
+    # Logging settings
+    Setting('loggers', help='Configure loggers, see\nhttp://docs.python.org/library/logging.html#configuration-file-format', wrap=False),
+    Setting('loggers', 'keys', 'root, hooke', help='Hooke only uses the hooke logger, but other included modules may also use logging and you can configure their loggers here as well.'),
+    Setting('handlers', help='Configure log handlers, see\nhttp://docs.python.org/library/logging.html#configuration-file-format', wrap=False),
+    Setting('handlers', 'keys', 'hand1'),
+    Setting('formatters', help='Configure log formatters, see\nhttp://docs.python.org/library/logging.html#configuration-file-format', wrap=False),
+    Setting('formatters', 'keys', 'form1'),
+    Setting('logger_root', help='Configure the root logger, see\nhttp://docs.python.org/library/logging.html#configuration-file-format', wrap=False),
+    Setting('logger_root', 'level', 'NOTSET'),
+    Setting('logger_root', 'handlers', 'hand1'),
+    Setting('logger_hooke', help='Configure the hooke logger, see\nhttp://docs.python.org/library/logging.html#configuration-file-format', wrap=False),
+    Setting('logger_hooke', 'level', 'DEBUG'),
+    Setting('logger_hooke', 'handlers', 'hand1', help='No specific handlers here, just propagate up to the root logger'),
+    Setting('logger_hooke', 'propagate', '0'),
+    Setting('logger_hooke', 'qualname', 'hooke'),
+    Setting('handler_hand1', help='Configure the default log handler, see\nhttp://docs.python.org/library/logging.html#configuration-file-format', wrap=False),
+    Setting('handler_hand1', 'class', 'StreamHandler'),
+    Setting('handler_hand1', 'level', 'NOTSET'),
+    Setting('handler_hand1', 'formatter', 'form1'),
+    Setting('handler_hand1', 'args', '(sys.stderr,)'),
+    Setting('formatter_form1', help='Configure the default log formatter, see\nhttp://docs.python.org/library/logging.html#configuration-file-format', wrap=False),
+    Setting('formatter_form1', 'format', '%(asctime)s %(levelname)s %(message)s'),
+    Setting('formatter_form1', 'datefmt', '', help='Leave blank for ISO8601, e.g. "2003-01-23 00:29:50,411".'),
+    Setting('formatter_form1', 'class', 'logging.Formatter'),
     ]
 
 def get_setting(settings, match):
@@ -138,10 +131,18 @@ class HookeConfigParser (configparser.SafeConfigParser):
     >>> c = HookeConfigParser(paths=DEFAULT_PATHS,
     ...                       default_settings=DEFAULT_SETTINGS)
     >>> c.write(sys.stdout) # doctest: +ELLIPSIS
-    # Control display appearance: colour, ???, etc.
-    [display]
-    colour_ext = None
-    colour_ret = None
+    # Default environmental conditions in case they are not specified in
+    # the force curve data.
+    [conditions]
+    # Temperature in Kelvin
+    temperature = 301
+    <BLANKLINE>
+    # Configure loggers, see
+    # http://docs.python.org/library/logging.html#configuration-file-format
+    [loggers]
+    # Hooke only uses the hooke logger, but other included modules may
+    # also use logging and you can configure their loggers here as well.
+    keys = root, hooke
     ...
     """
     def __init__(self, paths=None, default_settings=None, defaults=None,