Python執行個體淺談之五Python守護進程和指令碼單例運行

標籤：python

一、簡介

     守護進程最重要的特性是後台運行；它必須與其運行前的環境隔離開來，這些環境包括未關閉的檔案描述符、控制終端、會話和進程組、工作目錄以及檔案建立掩碼等；它可以在系統啟動時從啟動指令碼/etc/rc.d中啟動，可以由inetd守護進程啟動，也可以有作業規划進程crond啟動，還可以由使用者終端（通常是shell）執行。
       Python有時需要保證只運行一個指令碼執行個體，以避免資料的衝突。

二、Python守護進程
1、函數實現

#!/usr/bin/env python#coding: utf-8import sys, os'''將當前進程fork為一個守護進程   注意：如果你的守護進程是由inetd啟動的，不要這樣做！inetd完成了   所有需要做的事情，包括重新導向標準檔案描述符，需要做的事情只有chdir()和umask()了'''def daemonize (stdin='/dev/null', stdout='/dev/null', stderr='/dev/null'):     #重新導向標準檔案描述符（預設情況下定向到/dev/null）    try:         pid = os.fork()           #父進程(交談群組頭領進程)退出，這意味著一個非交談群組頭領進程永遠不能重新獲得控制終端。        if pid > 0:            sys.exit(0)   #父進程退出    except OSError, e:         sys.stderr.write ("fork #1 failed: (%d) %s\n" % (e.errno, e.strerror) )        sys.exit(1)     #從母體環境脫離    os.chdir("/")  #chdir確認進程不保持任何目錄於使用狀態，否則不能umount一個檔案系統。也可以改變到對於精靈運行重要的檔案所在目錄    os.umask(0)    #調用umask(0)以便擁有對於寫的任何東西的完全控制，因為有時不知道繼承了什麼樣的umask。    os.setsid()    #setsid調用成功後，進程成為新的交談群組長和新的進程組長，並與原來的登入工作階段和進程組脫離。     #執行第二次fork    try:         pid = os.fork()         if pid > 0:            sys.exit(0)   #第二個父進程退出    except OSError, e:         sys.stderr.write ("fork #2 failed: (%d) %s\n" % (e.errno, e.strerror) )        sys.exit(1)     #進程已經是守護進程了，重新導向標準檔案描述符    for f in sys.stdout, sys.stderr: f.flush()    si = open(stdin, 'r')    so = open(stdout, 'a+')    se = open(stderr, 'a+', 0)    os.dup2(si.fileno(), sys.stdin.fileno())    #dup2函數原子化關閉和複製檔案描述符    os.dup2(so.fileno(), sys.stdout.fileno())    os.dup2(se.fileno(), sys.stderr.fileno())#樣本函數：每秒列印一個數字和時間戳記def main():    import time    sys.stdout.write('Daemon started with pid %d\n' % os.getpid())    sys.stdout.write('Daemon stdout output\n')    sys.stderr.write('Daemon stderr output\n')    c = 0    while True:        sys.stdout.write('%d: %s\n' %(c, time.ctime()))        sys.stdout.flush()        c = c+1        time.sleep(1)if __name__ == "__main__":      daemonize('/dev/null','/tmp/daemon_stdout.log','/tmp/daemon_error.log')      main()

        可以通過命令ps -ef | grep daemon.py查看後台啟動並執行繼承，在/tmp/daemon_error.log會記錄錯誤作業記錄，在/tmp/daemon_stdout.log會記錄標準輸出日誌。

2、類實現

#!/usr/bin/env python#coding: utf-8#python類比linux的守護進程import sys, os, time, atexit, stringfrom signal import SIGTERMclass Daemon:  def __init__(self, pidfile, stdin='/dev/null', stdout='/dev/null', stderr='/dev/null'):      #需要擷取調試資訊，改為stdin='/dev/stdin', stdout='/dev/stdout', stderr='/dev/stderr'，以root身份運行。    self.stdin = stdin    self.stdout = stdout    self.stderr = stderr    self.pidfile = pidfile    def _daemonize(self):    try:      pid = os.fork()    #第一次fork，產生子進程，脫離父進程      if pid > 0:        sys.exit(0)      #退出主進程    except OSError, e:      sys.stderr.write('fork #1 failed: %d (%s)\n' % (e.errno, e.strerror))      sys.exit(1)      os.chdir("/")      #修改工作目錄    os.setsid()        #設定新的會話串連    os.umask(0)        #重新設定檔案建立許可權      try:      pid = os.fork() #第二次fork，禁止進程開啟終端      if pid > 0:        sys.exit(0)    except OSError, e:      sys.stderr.write('fork #2 failed: %d (%s)\n' % (e.errno, e.strerror))      sys.exit(1)       #重新導向檔案描述符    sys.stdout.flush()    sys.stderr.flush()    si = file(self.stdin, 'r')    so = file(self.stdout, 'a+')    se = file(self.stderr, 'a+', 0)    os.dup2(si.fileno(), sys.stdin.fileno())    os.dup2(so.fileno(), sys.stdout.fileno())    os.dup2(se.fileno(), sys.stderr.fileno())       #註冊退出函數，根據檔案pid判斷是否存在進程    atexit.register(self.delpid)    pid = str(os.getpid())    file(self.pidfile,'w+').write('%s\n' % pid)    def delpid(self):    os.remove(self.pidfile)  def start(self):     #檢查pid檔案是否存在以探測是否存在進程    try:      pf = file(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)      sys.exit(1)        #啟動監控    self._daemonize()    self._run()  def stop(self):    #從pid檔案中擷取pid    try:      pf = file(self.pidfile,'r')      pid = int(pf.read().strip())      pf.close()    except IOError:      pid = None      if not pid:   #重啟不報錯      message = 'pidfile %s does not exist. Daemon not running!\n'      sys.stderr.write(message % self.pidfile)      return     #殺進程    try:      while 1:        os.kill(pid, SIGTERM)        time.sleep(0.1)        #os.system('hadoop-daemon.sh stop datanode')        #os.system('hadoop-daemon.sh stop tasktracker')        #os.remove(self.pidfile)    except OSError, err:      err = str(err)      if err.find('No such process') > 0:        if os.path.exists(self.pidfile):          os.remove(self.pidfile)      else:        print str(err)        sys.exit(1)  def restart(self):    self.stop()    self.start()  def _run(self):    """ run your fun"""    while True:      #fp=open('/tmp/result','a+')      #fp.write('Hello World\n')      sys.stdout.write('%s:hello world\n' % (time.ctime(),))      sys.stdout.flush()       time.sleep(2)    if __name__ == '__main__':    daemon = Daemon('/tmp/watch_process.pid', stdout = '/tmp/watch_stdout.log')    if len(sys.argv) == 2:        if 'start' == sys.argv[1]:            daemon.start()        elif 'stop' == sys.argv[1]:            daemon.stop()        elif 'restart' == sys.argv[1]:            daemon.restart()        else:            print 'unknown command'            sys.exit(2)        sys.exit(0)    else:        print 'usage: %s start|stop|restart' % sys.argv[0]        sys.exit(2)

運行結果：

       可以參考：http://www.jejik.com/articles/2007/02/a_simple_unix_linux_daemon_in_python/，它是當Daemon設計成一個模板，在其他檔案中from daemon import Daemon，然後定義子類，重寫run()方法實現自己的功能。

class MyDaemon(Daemon):    def run(self):        while True:            fp=open('/tmp/run.log','a+')            fp.write('Hello World\n')            time.sleep(1)

        不足：訊號處理signal.signal(signal.SIGTERM, cleanup_handler)暫時沒有安裝，註冊程式退出時的回呼函數delpid()沒有被調用。
       然後，再寫個shell命令，加入開機啟動服務，每隔2秒檢測守護進程是否啟動，若沒有啟動則啟動，自動監控恢複程式。     

#/bin/shwhile truedo  count=`ps -ef | grep "daemonclass.py" | grep -v "grep"`  if [ "$?" != "0" ]; then     daemonclass.py start  fi  sleep 2done

三、python保證只能運行一個指令碼執行個體
1、開啟檔案本身加鎖

#!/usr/bin/env python#coding: utf-8import fcntl, sys, time, ospidfile = 0def ApplicationInstance():    global pidfile    pidfile = open(os.path.realpath(__file__), "r")    try:        fcntl.flock(pidfile, fcntl.LOCK_EX | fcntl.LOCK_NB) #建立一個獨佔鎖定,並且所被鎖住其他進程不會阻塞    except:        print "another instance is running..."        sys.exit(1)if __name__ == "__main__":    ApplicationInstance()    while True:        print 'running...'        time.sleep(1)

       注意：open()參數不能使用w，否則會覆蓋本身檔案；pidfile必須聲明為全域變數，否則局部變數生命週期結束，檔案描述符會因引用計數為0被系統回收（若整個函數寫在主函數中，則不需要定義成global）。               

2、開啟自訂檔案並加鎖

#!/usr/bin/env python#coding: utf-8import fcntl, sys, timepidfile = 0def ApplicationInstance():    global pidfile    pidfile = open("instance.pid", "w")    try:        fcntl.lockf(pidfile, fcntl.LOCK_EX | fcntl.LOCK_NB)  #建立一個獨佔鎖定,並且所被鎖住其他進程不會阻塞    except  IOError:        print "another instance is running..."        sys.exit(0)if __name__ == "__main__":    ApplicationInstance()    while True:        print 'running...'        time.sleep(1)

3、檢測檔案中PID

#!/usr/bin/env python#coding: utf-8import time, os, sysimport signalpidfile = '/tmp/process.pid'def sig_handler(sig, frame):    if os.path.exists(pidfile):        os.remove(pidfile)    sys.exit(0)def ApplicationInstance():    signal.signal(signal.SIGTERM, sig_handler)    signal.signal(signal.SIGINT, sig_handler)    signal.signal(signal.SIGQUIT, sig_handler)    try:      pf = file(pidfile, 'r')      pid = int(pf.read().strip())      pf.close()    except IOError:      pid = None      if pid:      sys.stdout.write('instance is running...\n')      sys.exit(0)    file(pidfile, 'w+').write('%s\n' % os.getpid())if __name__ == "__main__":    ApplicationInstance()    while True:        print 'running...'        time.sleep(1)

  
4、檢測特定檔案夾或檔案

#!/usr/bin/env python#coding: utf-8import time, commands, signal, sysdef sig_handler(sig, frame):    if os.path.exists("/tmp/test"):        os.rmdir("/tmp/test")    sys.exit(0)def ApplicationInstance():    signal.signal(signal.SIGTERM, sig_handler)    signal.signal(signal.SIGINT, sig_handler)    signal.signal(signal.SIGQUIT, sig_handler)    if commands.getstatusoutput("mkdir /tmp/test")[0]:        print "instance is running..."        sys.exit(0)if __name__ == "__main__":    ApplicationInstance()    while True:        print 'running...'        time.sleep(1)

       也可以檢測某一個特定的檔案，判斷檔案是否存在：

import osimport os.pathimport time  #class used to handle one application instance mechanismclass ApplicationInstance: #specify the file used to save the application instance piddef __init__( self, pid_file ):self.pid_file = pid_fileself.check()self.startApplication() #check if the current application is already runningdef check( self ):#check if the pidfile existsif not os.path.isfile( self.pid_file ):return #read the pid from the filepid = 0try:file = open( self.pid_file, 'rt' )data = file.read()file.close()pid = int( data )except:pass#check if the process with specified by pid existsif 0 == pid:return try:os.kill( pid, 0 )#this will raise an exception if the pid is not validexcept:return #exit the applicationprint "The application is already running..."exit(0) #exit raise an exception so don't put it in a try/except block #called when the single instance starts to save it's piddef startApplication( self ):file = open( self.pid_file, 'wt' )file.write( str( os.getpid() ) )file.close() #called when the single instance exit ( remove pid file )def exitApplication( self ):try:os.remove( self.pid_file )except:pass  if __name__ == '__main__':#create application instanceappInstance = ApplicationInstance( '/tmp/myapp.pid' ) #do something hereprint "Start MyApp"time.sleep(5)#sleep 5 secondsprint "End MyApp" #remove pid fileappInstance.exitApplication()

        上述os.kill( pid, 0 )用於檢測一個為pid的進程是否還活著，若該pid的進程已經停止則拋出異常，若正在運行則不發送kill訊號。

5、socket監聽一個特定連接埠

#!/usr/bin/env python#coding: utf-8import socket, time, sysdef ApplicationInstance():    try:            global s        s = socket.socket()        host = socket.gethostname()        s.bind((host, 60123))    except:        print "instance is running..."        sys.exit(0)if __name__ == "__main__":    ApplicationInstance()    while True:        print 'running...'        time.sleep(1)

可以將該函數使用裝飾器實現，便於重用（效果與上述相同）：

#!/usr/bin/env python#coding: utf-8import socket, time, sysimport functools#使用裝飾器實現def ApplicationInstance(func):    @functools.wraps(func)    def fun(*args,**kwargs):        import socket        try:            global s            s = socket.socket()            host = socket.gethostname()            s.bind((host, 60123))        except:            print('already has an instance...')            return None        return func(*args,**kwargs)    return fun@ApplicationInstancedef main():    while True:        print 'running...'        time.sleep(1)if __name__ == "__main__":    main()

四、總結（1）守護進程和單指令碼運行在實際應用中比較重要，方法也比較多，可選擇合適的來進行修改，可以將它們做成一個單獨的類或模板，然後子類化實現自訂。
（2）daemon監控進程自動回復避免了nohup和&的使用，並配合shell指令碼可以省去很多不定時啟動掛掉伺服器的麻煩。
（3）若有更好的設計和想法，可隨時留言，在此先感謝！

Python執行個體淺談之五Python守護進程和指令碼單例運行