enh: allow disabling logging to a file

Author: satra

doc/users/config_file.rst

@@ -23,6 +23,9 @@ Logging
 *interface_level*
 	How detailed the logs regarding interface execution should be (possible
 	values: ``INFO`` and ``DEBUG``; default value: ``INFO``)
+*log_to_file*
+    Indicates whether logging should also send the output to a file (possible
+    values: ``true`` and ``false``; default value: ``true``)
 *log_directory*
 	Where to store logs. (string, default value: home directory)
 *log_size*

examples/fsl_tutorial_compact.py

@@ -1,9 +1,9 @@
 # emacs: -*- mode: python; py-indent-offset: 4; indent-tabs-mode: nil -*-
 # vi: set ft=python sts=4 ts=4 sw=4 et:
 """
-===========================
-Using FSL for fMRI analysis
-===========================
+=======================================
+Reusing FSL workflows for fMRI analysis
+=======================================
 
 A workflow that uses fsl to perform a first level analysis on the nipype
 tutorial data set::
@@ -16,6 +16,15 @@
 
 import os                                    # system functions
 
+"""
+.. note::
+    config for logging should be set before anything else
+"""
+
+from nipype.utils.config import config
+config.set('logging', 'log_to_file', 'false')
+config.set_log_dir(os.getcwd())
+
 import nipype.interfaces.io as nio           # Data i/o
 import nipype.interfaces.fsl as fsl          # fsl
 import nipype.interfaces.utility as util     # utility

nipype/utils/config.py

@@ -18,6 +18,7 @@
 workflow_level = INFO
 filemanip_level = INFO
 interface_level = INFO
+log_to_file = true
 log_directory = %s
 log_size = 16384000
 log_rotate = 4

nipype/utils/logger.py

@@ -12,27 +12,33 @@
     warn("ConcurrentLogHandler not installed. Using builtin log handler")
     from logging.handlers import RotatingFileHandler as RFHandler
 from nipype.utils.config import config
+from nipype.utils.misc import str2bool
 
 #Sets up logging for pipeline and nodewrapper execution
 LOG_FILENAME = os.path.join(config.get('logging', 'log_directory'),
                             'pypeline.log')
+fmt=('%(asctime)s,%(msecs)d %(name)-2s '
+     '%(levelname)-2s:\n\t %(message)s')
+datefmt='%y%m%d-%H:%M:%S'
+#logging.basicConfig(format=fmt, datefmt=datefmt, stream=sys.stdout)
 logging.basicConfig(stream=sys.stdout)
 logger = logging.getLogger('workflow')
 fmlogger = logging.getLogger('filemanip')
 iflogger = logging.getLogger('interface')
-hdlr = RFHandler(LOG_FILENAME,
-                 maxBytes=int(config.get('logging', 'log_size')),
-                 backupCount=int(config.get('logging', 'log_rotate')))
-formatter = logging.Formatter(fmt=('%(asctime)s,%(msecs)d %(name)-2s '
-                                   '%(levelname)-2s:\n\t %(message)s'),
-                              datefmt='%y%m%d-%H:%M:%S')
-hdlr.setFormatter(formatter)
-logger.addHandler(hdlr)
+
+if str2bool(config.get('logging', 'log_to_file')):
+    hdlr = RFHandler(LOG_FILENAME,
+                     maxBytes=int(config.get('logging', 'log_size')),
+                     backupCount=int(config.get('logging', 'log_rotate')))
+    formatter = logging.Formatter(fmt=fmt, datefmt=datefmt)
+    hdlr.setFormatter(formatter)
+    logger.addHandler(hdlr)
+    fmlogger.addHandler(hdlr)
+    iflogger.addHandler(hdlr)
+
 logger.setLevel(logging.getLevelName(config.get('logging', 'workflow_level')))
-fmlogger.addHandler(hdlr)
 fmlogger.setLevel(logging.getLevelName(config.get('logging',
                                                   'filemanip_level')))
-iflogger.addHandler(hdlr)
 iflogger.setLevel(logging.getLevelName(config.get('logging',
                                                   'interface_level')))