Fix log file header repetition in some cscripts (#3066)

Jürgen Knödlseder
1 parent 77a829e9
Showing 6 changed files with 20 additions and 18 deletions
ChangeLog
NEWS
doc/source/admin/release_history/1.7.rst
pyext/ctlikelihood.i
pyext/ctobservation.i
pyext/ctool.i
-2019-11-14
+2019-11-15
         * Version 1.7.0 released
         ========================
+        Fix log file header repetition in some cscripts (#3066)
         Add Moon constraints to csviscube (#3065)
         Remove response cache before source testing in cttsmap (#2973)
         Enabling running of example scripts from objects in memory (#2925)
 New Features and Important Changes in ctools 1.7.0
-14 November 2019
+15 November 2019
 Introduction
@@ -31,7 +31,12 @@ None
 Base classes
 ------------
-None
+The headers in the log files created by cscripts that were derived from the
+ctools.cscript base class were repeated. This repetition was not present in
+the other base classes due to a reopening of the log file in those classes.
+The logic was changed so that the cscripts now behave like the ctools. A log
+file is not written by default in Python, the logFileOpen() method needs to
+be called for that. And the header is only written once in the log file (#3066).
 ctbin - CTA event binning
@@ -17,6 +17,8 @@ In particular, this release provides:
 Bug fixes
 ---------
+* [`3066 <https://cta-redmine.irap.omp.eu/issues/3066>`_] -
+  Fix log file header repetition in some cscripts
 Improvements
 /***************************************************************************
  *              ctlikelihood - Base class for likelihood tools             *
  * ----------------------------------------------------------------------- *
- *  copyright (C) 2016-2018 by Juergen Knoedlseder                         *
+ *  copyright (C) 2016-2019 by Juergen Knoedlseder                         *
  * ----------------------------------------------------------------------- *
  *                                                                         *
  *  This program is free software: you can redistribute it and/or modify   *
@@ -187,13 +187,11 @@ def _init_cslikelihood(self, name, version, argv):
     else:
         cslikelihood.__init__(self, name, version)
     # Set logger properties
-    self._log_header()
     self._log.date(True)
 cslikelihood._init_cslikelihood = _init_cslikelihood
 # Execute the script
 def _execute(self):
-    self.logFileOpen()
     self._read_ahead(True)
     self.run()
     self.save()
@@ -202,7 +202,6 @@ def _init_csobservation(self, name, version, argv):
     else:
         csobservation.__init__(self, name, version)
     # Set logger properties
-    self._log_header()
     self._log.date(True)
 csobservation._init_csobservation = _init_csobservation
@@ -217,7 +216,6 @@ cscript._unbinned_observations = _unbinned_observations
 # Execute the script
 def _execute(self):
-    self.logFileOpen()
     self._read_ahead(True)
     self.run()
     self.save()
@@ -198,7 +198,7 @@ public:
  * handling.
  ***************************************************************************/
 class cscript : public ctool  {
-public:        
+public:
     // Constructors and destructors
     cscript(const std::string& name,
             const std::string& version);
@@ -276,23 +276,21 @@ def _set_input_obs(self, argv):
     if len(argv) > 0 and isinstance(argv[0],gammalib.GObservations):
         obs  = argv[0]
         argv = argv[1:]
-    else:      
+    else:
         obs = gammalib.GObservations()
     return (obs, argv)
 cscript._set_input_obs = _set_input_obs 
 # Initialise application by calling the appropriate class constructor
 def _init_cscript(self, name, version, argv):
-    if len(argv) == 0:
-        cscript.__init__(self, name, version)
-    elif len(argv) == 1:
-        cscript.__init__(self, name, version, *argv)
-    elif len(argv) == 3:
-        cscript.__init__(self, name, version, argv[2])
+    if len(argv) > 0:
+        if len(argv) == 3 and argv[0] == name and argv[1] == version:
+            cscript.__init__(self, name, version, argv[2])
+        else:
+            cscript.__init__(self, name, version, *argv)
     else:
-        raise TypeError('Invalid number of arguments given.')
+        cscript.__init__(self, name, version)
     # Set logger properties
-    self._log_header()
     self._log.date(True)
 cscript._init_cscript = _init_cscript