Pythonで簡単にWindowsサービスを作る

2014-04-21 (最終更新: 2016-08-14)

Pythonで書いた処理をバックグラウンドで動かしておきたいときに、Windowsサービスとして書いておくとPC起動時の自動起動や開始・停止が簡単にできます。

PythonでWindowsサービスを書くにはpywin32モジュールを使うと簡単です。

コード

次のコードで、1秒毎に日付をファイルに出力するサービスが作れます。好きな処理をさせるにはwhileの中身を変えます。

	import win32serviceutil

	class SampleService(win32serviceutil.ServiceFramework):
	_svc_name_ = 'SampleService'
	_svc_display_name_ = 'Sample Service'
	_svc_description_ = 'This is Sample service.'

	def SvcDoRun(self):
	self.run = True
	while self.run:
	# Write datetime.now() every second
	import time, datetime
	time.sleep(1)
	open(r'C:\test.txt', 'a').write('%s\n' % datetime.datetime.now())

	def SvcStop(self):
	self.run = False

	if __name__ == '__main__':
	win32serviceutil.HandleCommandLine(SampleService)

view raw service.py hosted with ❤ by GitHub

サービスではターミナルに情報を出力できないので、ファイルやWindowsイベントログなどに出力しましょう。

スプリクトを直接実行した場合はwin32serviceutil.HandleCommandLine()が呼ばれ、サービスの登録や開始といったいくつかのコマンドラインオプションが指定可能です。

以下の例以外のオプションもあります。オプション無しでスプリクトを実行するとオプション一覧が表示されます。

python service.py install

サービスの登録に必要なのは、以下の2つです。

python service.py start

サービスが開始されると、SvcDoRun()がメインスレッドから呼ばれます。

SvcDoRun()が終了するとサービスが終了してしまうので、サービスの停止が指示されるまでwhileループを回すなどして処理を続ける必要があります。

python service.py stop

サービスが停止されると、SvcStop()がメインスレッドとは別のスレッドから呼ばれます。上の例ではサービス停止時にself.runを偽にすることで処理を止めています。