Python Flask作为Windows服务

Question

我正在尝试让一个Flask应用程序在Windows中作为服务运行。我已经尝试按照此处和此处的建议实施解决方案，但没有成功。

我有一个只有两个文件的简单文件夹：

Project
 |
 +-- myapp.py   
 +-- win32_service.py

在myapp.py内部是一个简单的Flask应用程序：

from flask import Flask

app = Flask(__name__)

@app.route('/')
def hello_world():
    return 'Hello, World!'

和服务框架win32_service.py：

import win32serviceutil
import win32service
import win32event
import win32evtlogutil
import servicemanager
import socket
import time
import logging
import os
import sys

sys.path.append(os.path.dirname(__name__))

from myapp import app

logging.basicConfig(
    filename = r'c:\tmp\flask-service.log',
    level = logging.DEBUG, 
    format = '[flaskapp] %(levelname)-7.7s %(message)s'
)

class HelloFlaskSvc (win32serviceutil.ServiceFramework):
    _svc_name_ = "FlaskApp"
    _svc_display_name_ = "FlaskApp Service"

    def __init__(self, *args):
        win32serviceutil.ServiceFramework.__init__(self, *args)
        self.hWaitStop = win32event.CreateEvent(None,0,0,None)
        socket.setdefaulttimeout(5)
        self.stop_requested = False

    def SvcStop(self):
        self.ReportServiceStatus(win32service.SERVICE_STOP_PENDING)
        win32event.SetEvent(self.hWaitStop)
        self.ReportServiceStatus(win32service.SERVICE_STOPPED)
        logging.info('Stopped service ...')
        self.stop_requested = True

    def SvcDoRun(self):
        servicemanager.LogMsg(
            servicemanager.EVENTLOG_INFORMATION_TYPE,
            servicemanager.PYS_SERVICE_STARTED,
            (self._svc_name_,'')
        )

        self.main()

    def main(self):
        app.run(host="127.0.0.1", port=8000)

if __name__ == '__main__':
    if len(sys.argv) == 1:
        servicemanager.Initialize()
        servicemanager.PrepareToHostSingle(HelloFlaskSvc)
        servicemanager.StartServiceCtrlDispatcher()
    else:
        win32serviceutil.HandleCommandLine(HelloFlaskSvc)

然后，我使用以下命令将其编译为exe文件pyinstaller：

pyinstaller --onefile --hidden-import win32timezone win32_service.py

我得到编译exe成功建立。然后，我继续注册该服务（使用管理员权限打开cmd）：

>>> win32_service.exe install
> Installing service FlaskApp
> Service installed

我尝试启动它：

>>> win32_service.exe start
> Starting service FlaskApp

但是随后什么也没有发生（没有错误）。另外，如果我尝试从“任务管理器”启动它，则将“状态”更改为Starting，然后更改为Stopped。

这些是安装在virtualenv中的模块：

altgraph==0.16.1
Click==7.0
Flask==1.0.2
future==0.17.1
itsdangerous==1.1.0
Jinja2==2.10.1
macholib==1.11
MarkupSafe==1.1.1
pefile==2018.8.8
PyInstaller==3.4
pyodbc==4.0.26
pywin32==224
pywin32-ctypes==0.2.0
Werkzeug==0.15.2

系统规格：

Python - 3.6.5 
OS     - Windows 10

我在这里想念的是什么？任何帮助表示赞赏。

编辑

Windows EventViewer显示错误：

The description for Event ID 3 from source FlaskApp cannot be found. Either the component that raises this event is not installed on your local computer or the installation is corrupted. You can install or repair the component on the local computer.

If the event originated on another computer, the display information had to be saved with the event.

The following information was included with the event: 

Traceback (most recent call last):
  File "lib\site-packages\win32\lib\win32serviceutil.py", line 839, in SvcRun
  File "win32_service.py", line 47, in SvcDoRun
  File "win32_service.py", line 50, in main
  File "lib\site-packages\flask\app.py", line 938, in run
  File "lib\site-packages\flask\cli.py", line 629, in show_server_banner
  File "lib\site-packages\click\utils.py", line 260, in echo
SystemError: <built-in method replace of str object at 0x000001E36AD465D0> returned a result with an error set

编辑2

如果我使用单个spec文件，则隐藏的导入找不到某些模块（这是来自的输出pyinstaller：

4972 INFO: Analyzing hidden import 'ClickFlask'
4973 ERROR: Hidden import 'ClickFlask' not found
4974 INFO: Analyzing hidden import 'future'
4981 INFO: Analyzing hidden import 'itsdangerous'
5029 INFO: Analyzing hidden import 'Jinja2'
5030 ERROR: Hidden import 'Jinja2' not found
5030 INFO: Analyzing hidden import 'MarkupSafe'
5032 ERROR: Hidden import 'MarkupSafe' not found
5033 INFO: Analyzing hidden import 'pyodbc'
5034 INFO: Analyzing hidden import 'pywin32'
5035 ERROR: Hidden import 'pywin32' not found
5035 INFO: Analyzing hidden import 'pywin32-ctypes'
5036 ERROR: Hidden import 'pywin32-ctypes' not found

可能与此有关吗？为什么找到某些模块而其他模块却找不到？我正在使用virtualenv。

Answer 1

根据Reddit 帖子，添加所有库hiddenimports应该可以解决您的问题，我自己尝试过，它确实有效！

因此，在您的项目目录中创建一个文件，名为 win32_service.spec为以下内容

# -*- mode: python -*-

block_cipher = None


a = Analysis(['win32_service.py'],
             pathex=['C:\\Users\\Win7\\Desktop\\FaaS'],
             binaries=[],
             datas=[],
             hiddenimports=['win32timezone',
                            'altgraph',
                            'Click'
                            'Flask',
                            'future',
                            'itsdangerous',
                            'Jinja2',
                            'macholib',
                            'MarkupSafe',
                            'pefile',
                            'PyInstaller',
                            'pyodbc',
                            'pywin32',
                            'pywin32-ctypes',
                            'Werkzeug',],
             hookspath=[],
             runtime_hooks=[],
             excludes=[],
             win_no_prefer_redirects=False,
             win_private_assemblies=False,
             cipher=block_cipher,
             noarchive=False)
pyz = PYZ(a.pure, a.zipped_data,
             cipher=block_cipher)
exe = EXE(pyz,
          a.scripts,
          a.binaries,
          a.zipfiles,
          a.datas,
          [],
          name='win32_service',
          debug=False,
          bootloader_ignore_signals=False,
          strip=False,
          upx=True,
          runtime_tmpdir=None,
          console=True )

不要忘记更改pathex变量

然后而不是pyinstaller --onefile --hidden-import win32timezone win32_service.py使用以下命令： pyinstaller --onefile win32_service.spec

Answer 2

我进一步研究了pyinstallergithub repo 并解决了这个问题。

似乎与pyinstaller有一些冲突Windows 10，但这个问题是我问题的关键。虽然产生错误的模块不一样。

我设法通过增加来解决它SystemError的异常lib\site-packages\click\utils.py，line 260在echo函数。

所以我改变了这个：

if message:
   file.write(message)

对此：

if message:
    try:
        file.write(message)
    except SystemError:
        pass

使用以下命令重建 exe：

pyinstaller --onefile --hidden-import win32timezone win32_service.py

安装了服务，然后它就正确启动了。