Python实例浅谈之五Python守护进程和脚本单例运行

一、简介

守护进程最重要的特性是后台运行；它必须与其运行前的环境隔离开来，这些环境包括未关闭的文件描述符、控制终端、会话和进程组、工作目录以及文件创建掩码等；它可以在系统启动时从启动脚本/etc/rc.d中启动，可以由inetd守护进程启动，也可以有作业规划进程crond启动，还可以由用户终端（通常是shell）执行。
       Python有时需要保证只运行一个脚本实例，以避免数据的冲突。

二、Python守护进程

1、函数实现

1. #!/usr/bin/env python
2. #coding: utf-8
3. import sys, os
4. '''将当前进程fork为一个守护进程
5. 注意：如果你的守护进程是由inetd启动的，不要这样做！inetd完成了
6. 所有需要做的事情，包括重定向标准文件描述符，需要做的事情只有chdir()和umask()了
7. '''
8. def daemonize (stdin='/dev/null', stdout='/dev/null', stderr='/dev/null'):
9. #重定向标准文件描述符（默认情况下定向到/dev/null）
10. try:
11. pid = os.fork()
12. #父进程(会话组头领进程)退出，这意味着一个非会话组头领进程永远不能重新获得控制终端。
13. if pid > 0:
14. sys.exit(0)   #父进程退出
15. except OSError, e:
16. sys.stderr.write ("fork #1 failed: (%d) %s\n" % (e.errno, e.strerror) )
17. sys.exit(1)
18. #从母体环境脱离
19. os.chdir("/")  #chdir确认进程不保持任何目录于使用状态，否则不能umount一个文件系统。也可以改变到对于守护程序运行重要的文件所在目录
20. os.umask(0)    #调用umask(0)以便拥有对于写的任何东西的完全控制，因为有时不知道继承了什么样的umask。
21. os.setsid()    #setsid调用成功后，进程成为新的会话组长和新的进程组长，并与原来的登录会话和进程组脱离。
22. #执行第二次fork
23. try:
24. pid = os.fork()
25. if pid > 0:
26. sys.exit(0)   #第二个父进程退出
27. except OSError, e:
28. sys.stderr.write ("fork #2 failed: (%d) %s\n" % (e.errno, e.strerror) )
29. sys.exit(1)
30. #进程已经是守护进程了，重定向标准文件描述符
31. for f in sys.stdout, sys.stderr: f.flush()
32. si = open(stdin, 'r')
33. so = open(stdout, 'a+')
34. se = open(stderr, 'a+', 0)
35. os.dup2(si.fileno(), sys.stdin.fileno())    #dup2函数原子化关闭和复制文件描述符
36. os.dup2(so.fileno(), sys.stdout.fileno())
37. os.dup2(se.fileno(), sys.stderr.fileno())
38. #示例函数：每秒打印一个数字和时间戳
39. def main():
40. import time
41. sys.stdout.write('Daemon started with pid %d\n' % os.getpid())
42. sys.stdout.write('Daemon stdout output\n')
43. sys.stderr.write('Daemon stderr output\n')
44. c = 0
45. while True:
46. sys.stdout.write('%d: %s\n' %(c, time.ctime()))
47. sys.stdout.flush()
48. c = c+1
49. time.sleep(1)
50. if __name__ == "__main__":
51. daemonize('/dev/null','/tmp/daemon_stdout.log','/tmp/daemon_error.log')
52. main()

可以通过命令ps -ef | grep daemon.py查看后台运行的继承，在/tmp/daemon_error.log会记录错误运行日志，在/tmp/daemon_stdout.log会记录标准输出日志。

2、类实现

1. #!/usr/bin/env python
2. #coding: utf-8
3. #python模拟linux的守护进程
4. import sys, os, time, atexit, string
5. from signal import SIGTERM
6. class Daemon:
7. def __init__(self, pidfile, stdin='/dev/null', stdout='/dev/null', stderr='/dev/null'):
8. #需要获取调试信息，改为stdin='/dev/stdin', stdout='/dev/stdout', stderr='/dev/stderr'，以root身份运行。
9. self.stdin = stdin
10. self.stdout = stdout
11. self.stderr = stderr
12. self.pidfile = pidfile
13. def _daemonize(self):
14. try:
15. pid = os.fork()    #第一次fork，生成子进程，脱离父进程
16. if pid > 0:
17. sys.exit(0)      #退出主进程
18. except OSError, e:
19. sys.stderr.write('fork #1 failed: %d (%s)\n' % (e.errno, e.strerror))
20. sys.exit(1)
21. os.chdir("/")      #修改工作目录
22. os.setsid()        #设置新的会话连接
23. os.umask(0)        #重新设置文件创建权限
24. try:
25. pid = os.fork() #第二次fork，禁止进程打开终端
26. if pid > 0:
27. sys.exit(0)
28. except OSError, e:
29. sys.stderr.write('fork #2 failed: %d (%s)\n' % (e.errno, e.strerror))
30. sys.exit(1)
31. #重定向文件描述符
32. sys.stdout.flush()
33. sys.stderr.flush()
34. si = file(self.stdin, 'r')
35. so = file(self.stdout, 'a+')
36. se = file(self.stderr, 'a+', 0)
37. os.dup2(si.fileno(), sys.stdin.fileno())
38. os.dup2(so.fileno(), sys.stdout.fileno())
39. os.dup2(se.fileno(), sys.stderr.fileno())
40. #注册退出函数，根据文件pid判断是否存在进程
41. atexit.register(self.delpid)
42. pid = str(os.getpid())
43. file(self.pidfile,'w+').write('%s\n' % pid)
44. def delpid(self):
45. os.remove(self.pidfile)
46. def start(self):
47. #检查pid文件是否存在以探测是否存在进程
48. try:
49. pf = file(self.pidfile,'r')
50. pid = int(pf.read().strip())
51. pf.close()
52. except IOError:
53. pid = None
54. if pid:
55. message = 'pidfile %s already exist. Daemon already running!\n'
56. sys.stderr.write(message % self.pidfile)
57. sys.exit(1)
58. #启动监控
59. self._daemonize()
60. self._run()
61. def stop(self):
62. #从pid文件中获取pid
63. try:
64. pf = file(self.pidfile,'r')
65. pid = int(pf.read().strip())
66. pf.close()
67. except IOError:
68. pid = None
69. if not pid:   #重启不报错
70. message = 'pidfile %s does not exist. Daemon not running!\n'
71. sys.stderr.write(message % self.pidfile)
72. return
73. #杀进程
74. try:
75. while 1:
76. os.kill(pid, SIGTERM)
77. time.sleep(0.1)
78. #os.system('hadoop-daemon.sh stop datanode')
79. #os.system('hadoop-daemon.sh stop tasktracker')
80. #os.remove(self.pidfile)
81. except OSError, err:
82. err = str(err)
83. if err.find('No such process') > 0:
84. if os.path.exists(self.pidfile):
85. os.remove(self.pidfile)
86. else:
87. print str(err)
88. sys.exit(1)
89. def restart(self):
90. self.stop()
91. self.start()
92. def _run(self):
93. """ run your fun"""
94. while True:
95. #fp=open('/tmp/result','a+')
96. #fp.write('Hello World\n')
97. sys.stdout.write('%s:hello world\n' % (time.ctime(),))
98. sys.stdout.flush()
99. time.sleep(2)
100. if __name__ == '__main__':
101. daemon = Daemon('/tmp/watch_process.pid', stdout = '/tmp/watch_stdout.log')
102. if len(sys.argv) == 2:
103. if 'start' == sys.argv[1]:
104. daemon.start()
105. elif 'stop' == sys.argv[1]:
106. daemon.stop()
107. elif 'restart' == sys.argv[1]:
108. daemon.restart()
109. else:
110. print 'unknown command'
111. sys.exit(2)
112. sys.exit(0)
113. else:
114. print 'usage: %s start|stop|restart' % sys.argv[0]
115. sys.exit(2)

运行结果：

可以参考：http://www.jejik.com/articles/2007/02/a_simple_unix_linux_daemon_in_python/，它是当Daemon设计成一个模板，在其他文件中from daemon import Daemon，然后定义子类，重写run()方法实现自己的功能。

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

不足：信号处理signal.signal(signal.SIGTERM, cleanup_handler)暂时没有安装，注册程序退出时的回调函数delpid()没有被调用。
       然后，再写个shell命令，加入开机启动服务，每隔2秒检测守护进程是否启动，若没有启动则启动，自动监控恢复程序。

1. #/bin/sh
2. while true
3. do
4. count=`ps -ef | grep "daemonclass.py" | grep -v "grep"`
5. if [ "$?" != "0" ]; then
6. daemonclass.py start
7. fi
8. sleep 2
9. done

三、python保证只能运行一个脚本实例

1、打开文件本身加锁

1. #!/usr/bin/env python
2. #coding: utf-8
3. import fcntl, sys, time, os
4. pidfile = 0
5. def ApplicationInstance():
6. global pidfile
7. pidfile = open(os.path.realpath(__file__), "r")
8. try:
9. fcntl.flock(pidfile, fcntl.LOCK_EX | fcntl.LOCK_NB) #创建一个排他锁,并且所被锁住其他进程不会阻塞
10. except:
11. print "another instance is running..."
12. sys.exit(1)
13. if __name__ == "__main__":
14. ApplicationInstance()
15. while True:
16. print 'running...'
17. time.sleep(1)

注意：open()参数不能使用w，否则会覆盖本身文件；pidfile必须声明为全局变量，否则局部变量生命周期结束，文件描述符会因引用计数为0被系统回收（若整个函数写在主函数中，则不需要定义成global）。               

2、打开自定义文件并加锁

1. #!/usr/bin/env python
2. #coding: utf-8
3. import fcntl, sys, time
4. pidfile = 0
5. def ApplicationInstance():
6. global pidfile
7. pidfile = open("instance.pid", "w")
8. try:
9. fcntl.lockf(pidfile, fcntl.LOCK_EX | fcntl.LOCK_NB)  #创建一个排他锁,并且所被锁住其他进程不会阻塞
10. except  IOError:
11. print "another instance is running..."
12. sys.exit(0)
13. if __name__ == "__main__":
14. ApplicationInstance()
15. while True:
16. print 'running...'
17. time.sleep(1)

3、检测文件中PID

1. #!/usr/bin/env python
2. #coding: utf-8
3. import time, os, sys
4. import signal
5. pidfile = '/tmp/process.pid'
6. def sig_handler(sig, frame):
7. if os.path.exists(pidfile):
8. os.remove(pidfile)
9. sys.exit(0)
10. def ApplicationInstance():
11. signal.signal(signal.SIGTERM, sig_handler)
12. signal.signal(signal.SIGINT, sig_handler)
13. signal.signal(signal.SIGQUIT, sig_handler)
14. try:
15. pf = file(pidfile, 'r')
16. pid = int(pf.read().strip())
17. pf.close()
18. except IOError:
19. pid = None
20. if pid:
21. sys.stdout.write('instance is running...\n')
22. sys.exit(0)
23. file(pidfile, 'w+').write('%s\n' % os.getpid())
24. if __name__ == "__main__":
25. ApplicationInstance()
26. while True:
27. print 'running...'
28. time.sleep(1)

  

4、检测特定文件夹或文件

1. #!/usr/bin/env python
2. #coding: utf-8
3. import time, commands, signal, sys
4. def sig_handler(sig, frame):
5. if os.path.exists("/tmp/test"):
6. os.rmdir("/tmp/test")
7. sys.exit(0)
8. def ApplicationInstance():
9. signal.signal(signal.SIGTERM, sig_handler)
10. signal.signal(signal.SIGINT, sig_handler)
11. signal.signal(signal.SIGQUIT, sig_handler)
12. if commands.getstatusoutput("mkdir /tmp/test")[0]:
13. print "instance is running..."
14. sys.exit(0)
15. if __name__ == "__main__":
16. ApplicationInstance()
17. while True:
18. print 'running...'
19. time.sleep(1)

也可以检测某一个特定的文件，判断文件是否存在：

1. import os
2. import os.path
3. import time
4. #class used to handle one application instance mechanism
5. class ApplicationInstance:
6. #specify the file used to save the application instance pid
7. def __init__( self, pid_file ):
8. self.pid_file = pid_file
9. self.check()
10. self.startApplication()
11. #check if the current application is already running
12. def check( self ):
13. #check if the pidfile exists
14. if not os.path.isfile( self.pid_file ):
15. return
16. #read the pid from the file
17. pid = 0
18. try:
19. file = open( self.pid_file, 'rt' )
20. data = file.read()
21. file.close()
22. pid = int( data )
23. except:
24. pass
25. #check if the process with specified by pid exists
26. if 0 == pid:
27. return
28. try:
29. os.kill( pid, 0 )   #this will raise an exception if the pid is not valid
30. except:
31. return
32. #exit the application
33. print "The application is already running..."
34. exit(0) #exit raise an exception so don't put it in a try/except block
35. #called when the single instance starts to save it's pid
36. def startApplication( self ):
37. file = open( self.pid_file, 'wt' )
38. file.write( str( os.getpid() ) )
39. file.close()
40. #called when the single instance exit ( remove pid file )
41. def exitApplication( self ):
42. try:
43. os.remove( self.pid_file )
44. except:
45. pass
46. if __name__ == '__main__':
47. #create application instance
48. appInstance = ApplicationInstance( '/tmp/myapp.pid' )
49. #do something here
50. print "Start MyApp"
51. time.sleep(5)   #sleep 5 seconds
52. print "End MyApp"
53. #remove pid file
54. appInstance.exitApplication()

上述os.kill( pid, 0 )用于检测一个为pid的进程是否还活着，若该pid的进程已经停止则抛出异常，若正在运行则不发送kill信号。

5、socket监听一个特定端口

1. #!/usr/bin/env python
2. #coding: utf-8
3. import socket, time, sys
4. def ApplicationInstance():
5. try:
6. global s
7. s = socket.socket()
8. host = socket.gethostname()
9. s.bind((host, 60123))
10. except:
11. print "instance is running..."
12. sys.exit(0)
13. if __name__ == "__main__":
14. ApplicationInstance()
15. while True:
16. print 'running...'
17. time.sleep(1)

可以将该函数使用装饰器实现，便于重用（效果与上述相同）：

1. #!/usr/bin/env python
2. #coding: utf-8
3. import socket, time, sys
4. import functools
5. #使用装饰器实现
6. def ApplicationInstance(func):
7. @functools.wraps(func)
8. def fun(*args,**kwargs):
9. import socket
10. try:
11. global s
12. s = socket.socket()
13. host = socket.gethostname()
14. s.bind((host, 60123))
15. except:
16. print('already has an instance...')
17. return None
18. return func(*args,**kwargs)
19. return fun
20. @ApplicationInstance
21. def main():
22. while True:
23. print 'running...'
24. time.sleep(1)
25. if __name__ == "__main__":
26. main()

四、总结

（1）守护进程和单脚本运行在实际应用中比较重要，方法也比较多，可选择合适的来进行修改，可以将它们做成一个单独的类或模板，然后子类化实现自定义。
（2）daemon监控进程自动恢复避免了nohup和&的使用，并配合shell脚本可以省去很多不定时启动挂掉服务器的麻烦。
（3）若有更好的设计和想法，可随时留言，在此先感谢！