1. 程式人生 > >Python例項淺談之五Python守護程序和指令碼單例執行

Python例項淺談之五Python守護程序和指令碼單例執行

一、簡介

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

二、Python守護程序

1、函式實現

#!/usr/bin/env python
#coding: utf-8
import 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, string
from signal import SIGTERM

class 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)
執行結果:
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/sh
while true
do
  count=`ps -ef | grep "daemonclass.py" | grep -v "grep"`
  if [ "$?" != "0" ]; then
     daemonclass.py start
  fi
  sleep 2
done

三、python保證只能執行一個指令碼例項

1、開啟檔案本身加鎖

#!/usr/bin/env python
#coding: utf-8
import fcntl, sys, time, os
pidfile = 0

def 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-8
import fcntl, sys, time
pidfile = 0

def 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-8
import time, os, sys
import signal

pidfile = '/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-8
import time, commands, signal, sys

def 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 os
import os.path
import time
 
 
#class used to handle one application instance mechanism
class ApplicationInstance:
 
	#specify the file used to save the application instance pid
	def __init__( self, pid_file ):
		self.pid_file = pid_file
		self.check()
		self.startApplication()
 
	#check if the current application is already running
	def check( self ):
		#check if the pidfile exists
		if not os.path.isfile( self.pid_file ):
			return
	 	#read the pid from the file
		pid = 0
		try:
			file = open( self.pid_file, 'rt' )
			data = file.read()
			file.close()
			pid = int( data )
		except:
			pass
		#check if the process with specified by pid exists
		if 0 == pid:
			return
 
		try:
			os.kill( pid, 0 )	#this will raise an exception if the pid is not valid
		except:
			return
 
		#exit the application
		print "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 pid
	def 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 instance
	appInstance = ApplicationInstance( '/tmp/myapp.pid' )
 
	#do something here
	print "Start MyApp"
	time.sleep(5)	#sleep 5 seconds
	print "End MyApp"
 
	#remove pid file
	appInstance.exitApplication()
        上述os.kill( pid, 0 )用於檢測一個為pid的程序是否還活著,若該pid的程序已經停止則丟擲異常,若正在執行則不傳送kill訊號。

5、socket監聽一個特定埠

#!/usr/bin/env python
#coding: utf-8
import socket, time, sys


def 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-8
import socket, time, sys
import 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

@ApplicationInstance
def main():
    while True:
        print 'running...'
        time.sleep(1)

if __name__ == "__main__":
    main()

四、總結

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