Adjust licence in file's header
[python-seth.git] / seth.py
diff --git a/seth.py b/seth.py
index cfc5ed4..feaa5b9 100644 (file)
--- a/seth.py
+++ b/seth.py
@@ -1,11 +1,22 @@
 # -*- coding: utf-8 -*-
-
-# Public Domain
-#
 # Copyright 2007, 2009 Sander Marechal <s.marechal@jejik.com>
 # Copyright 2010, 2011, 2012 Jack Kaliko <kaliko@azylum.org>
 #
 # http://www.jejik.com/articles/2007/02/a_simple_unix_linux_daemon_in_python/
+#
+# python-seth 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.
+#
+# python-seth 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 python-seth.  If not, see <http://www.gnu.org/licenses/>.
+
 
 import atexit
 import os
@@ -19,13 +30,20 @@ class Daemon(object):
     A generic daemon class.
 
     Usage: subclass the Daemon class and override the run() method
+
+        Daemon([pidfile[, stdin[, stdout[, stderr]]]])
+
+            pidfile : file to write pid to (default no pid file writen)
+            stdin   : standard input file descriptor (default to /dev/null)
+            stdout  : standard output file descriptor (default to /dev/null)
+            stderr  : standard error file descriptorr (default to /dev/null)
     """
-    version = "0.5"
+    version = '0.6'
 
     def __init__(self, pidfile,
-            stdin='/dev/null',
-            stdout='/dev/null',
-            stderr='/dev/null'):
+            stdin = os.devnull,
+            stdout = os.devnull,
+            stderr = os.devnull):
         self.stdin = stdin
         self.stdout = stdout
         self.stderr = stderr
@@ -49,8 +67,8 @@ class Daemon(object):
             if pid > 0:
                 # exit first parent
                 sys.exit(0)
-        except OSError, e:
-            sys.stderr.write('fork #1 failed: %d (%s)\n' % (e.errno, e.strerror))
+        except OSError as e:
+            sys.stderr.write('fork #1 failed: {0.errno:d} ({0.strerror})\n'.format(e))
             sys.exit(1)
 
         # Decouple from parent environment
@@ -64,17 +82,18 @@ class Daemon(object):
             if pid > 0:
                 # exit from second parent
                 sys.exit(0)
-        except OSError, e:
-            sys.stderr.write('fork #2 failed: %d (%s)\n' % (e.errno, e.strerror))
+        except OSError as e:
+            sys.stderr.write('fork #2 failed: {0.errno:d} ({0.strerror})\n'.format(e))
             sys.exit(1)
 
         self.write_pid()
         # redirect standard file descriptors
         sys.stdout.flush()
         sys.stderr.flush()
-        si = file(self.stdin, 'r')
-        so = file(self.stdout, 'a+')
-        se = file(self.stderr, 'a+', 0)
+        # TODO: binary or txt mode?
+        si = open(self.stdin,  mode='rb')
+        so = open(self.stdout, mode='ab+')
+        se = open(self.stderr, mode='ab+', buffering=0)
         os.dup2(si.fileno(), sys.stdin.fileno())
         os.dup2(so.fileno(), sys.stdout.fileno())
         os.dup2(se.fileno(), sys.stderr.fileno())
@@ -89,26 +108,28 @@ class Daemon(object):
         pid = str(os.getpid())
         try:
             os.umask(self.umask)
-            file(self.pidfile, 'w').write('%s\n' % pid)
-        except Exception, wpid_err:
-            sys.stderr.write(u'Error trying to write pid file: %s\n' % wpid_err)
+            open(self.pidfile, 'w').write('%s\n' % pid)
+        except Exception as wpid_err:
+            sys.stderr.write('Error trying to write pid file: {}\n'.format(wpid_err))
             sys.exit(1)
         os.umask(0)
         atexit.register(self.delpid)
 
     def signal_management(self):
-        # Declare signal handlers
+        """Declare signal handlers
+        """
         signal(SIGTERM, self.exit_handler)
 
     def exit_handler(self, signum, frame):
         sys.exit(1)
 
     def delpid(self):
+        """Remove PID file"""
         try:
             os.unlink(self.pidfile)
         except OSError as err:
-            message = 'Error trying to remove PID file: %s\n'
-            sys.stderr.write(message % err)
+            message = 'Error trying to remove PID file: {}\n'
+            sys.stderr.write(message.format(err))
 
     def start(self):
         """
@@ -116,15 +137,15 @@ class Daemon(object):
         """
         # Check for a pidfile to see if the daemon already runs
         try:
-            pf = file(self.pidfile, 'r')
+            pf = open(self.pidfile, 'r')
             pid = int(pf.read().strip())
             pf.close()
         except IOError:
             pid = None
 
         if pid:
-            message = 'pidfile %s already exist. Daemon already running?\n'
-            sys.stderr.write(message % self.pidfile)
+            message = 'pidfile {0.pidfile} already exist. Daemon already running?\n'
+            sys.stderr.write(message.format(self))
             sys.exit(1)
 
         # Start the daemon
@@ -145,26 +166,26 @@ class Daemon(object):
         """
         # Get the pid from the pidfile
         try:
-            pf = file(self.pidfile, 'r')
+            pf = open(self.pidfile, 'r')
             pid = int(pf.read().strip())
             pf.close()
         except IOError:
             pid = None
 
         if not pid:
-            message = 'pidfile %s does not exist. Is the Daemon running?\n'
-            sys.stderr.write(message % self.pidfile)
+            message = 'pidfile {0.pidfile} does not exist. Is the Daemon running?\n'
+            sys.stderr.write(message.format(self))
             return  # not an error in a restart
 
         # Try killing the daemon process
         try:
             os.kill(pid, SIGTERM)
             time.sleep(0.1)
-        except OSError, err:
+        except OSError as err:
             if err.errno == 3:
                 if os.path.exists(self.pidfile):
-                    message = "Daemon's not running? removing pid file %s.\n"
-                    sys.stderr.write(message % self.pidfile)
+                    message = "Daemon's not running? removing pid file {0.pidfile}.\n"
+                    sys.stderr.write(message.format(self))
                     os.remove(self.pidfile)
             else:
                 sys.stderr.write(err.strerror)