Flask-script使用及錯誤No module named flask._compat

先說問題

在使用過程到遇到問題，提示沒有flask._compat模塊

(flask-projs) [root@test-xxxx-01-vm]# python app.py
Traceback (most recent call last):
  File "/data/colinspace/temp/flask-demo/demoproj/app.py", line 5, in <module>
    from flask_script import Manager
  File "/data/colinspace/.pyenv/versions/flask-projs/lib/python3.9/site-packages/flask_script/__init__.py", line 15, in <module>
    from flask._compat import text_type
ModuleNotFoundError: No module named 'flask._compat'

剛開始沒有仔細看錯誤信息，慣性的去網上查找解決方案，大多都說是高版本存在問題，需要降配處理。

先說結果： 其實不用降配處理，因爲從錯誤中就可以發現問題所在

檢查了下本地安裝的版本

Flask              2.2.2
Flask-Script       2.0.6

嘗試降配到 1.1.4 、1.1.3 和 1.1.2 然後運行，又出現了很多其他類似的問題，比如

ImportError: cannot import name 'json' from 'itsdangerous'

或者

ImportError: cannot import name 'escape' from 'jinja2'

安裝網上的說法又升級、重新安裝先關模塊還是存在問題。

最終仔細看到錯誤發生在flask_script/__init__.py 文件，找 flask._compat 模塊，結果在 site-packages/flask/ 下面沒有看到 _compat.py 文件，在 site-packages/flask_script/ 下看到了

所以認定是 flask_script/__init__.py文件 15行 from flask._compat import text_type 書寫有誤。修改爲

# site-packages/flask_script/__init__.py
from flask_script._compat import text_type

然後運行程序正常

再談 Flask-Script

官方文檔 https://flask-script.readthedocs.io/en/latest/ 建議大家閱讀

看作者對 Flask-script的介紹

Flask腳本擴展支持在Flask中編寫外部腳本。這包括運行開發服務器、定製的Python shell、設置數據庫的腳本、cronjobs以及屬於web應用程序本身之外的其他命令行任務。

簡單理解是開發基於命令行的工具，用來實現非application邏輯的功能，比如應用首次安裝之後的數據初始化

官網的demo很簡單，先看集成Flask-script之後，未開發自定義command之前

from flask import Flask
from flask_script import Manager


app = Flask(__name__)
manager = Manager(app)

if __name__ == '__main__':
    # 注意這裏被 manager.run()接管， 而不是app.run()
    manager.run()

這個時候執行 python app.py 不會直接啓動一個 http server，而是輸出如下:

usage: app.py [-?] {shell,runserver} ...

positional arguments:
  {shell,runserver}
    shell            Runs a Python shell inside Flask application context.
    runserver        Runs the Flask development server i.e. app.run()

optional arguments:
  -?, --help         show this help message and exit

看到默認是包含了兩個命令

shell 是啓動一個 flask的shell交互環境
runserver 顧名思義就是爲了啓動服務

我們執行 python app.py runserver --help 來看看這個命令都支持那些參數

usage: app.py runserver [-?] [-h HOST] [-p PORT] [--threaded] [--processes PROCESSES] [--passthrough-errors] [-d] [-D]
                         [-r] [-R] [--ssl-crt SSL_CRT] [--ssl-key SSL_KEY]

Runs the Flask development server i.e. app.run()

optional arguments:
  -?, --help            show this help message and exit
  -h HOST, --host HOST
  -p PORT, --port PORT
  --threaded
  --processes PROCESSES
  --passthrough-errors
  -d, --debug           enable the Werkzeug debugger (DO NOT use in production code)
  -D, --no-debug        disable the Werkzeug debugger
  -r, --reload          monitor Python files for changes (not 100% safe for production use)
  -R, --no-reload       do not monitor Python files for changes
  --ssl-crt SSL_CRT     Path to ssl certificate
  --ssl-key SSL_KEY     Path to ssl key

所以這個時候執行 python app.py runserver -h 192.168.3.108 -p 5000 就可以啓動類似之前 app.run()方式啓動一個http server

自定義command

# encoding: utf-8
from flask import Flask
from flask_script import Manager
from flask_script import Command, Option


app = Flask(__name__)
manager = Manager(app)


# 通過定義方法的形式
@manager.command
def sayHi():
    print("Hi Flask-script")

# 通過函數方法定義有參數的命令
# 注意這裏不要在添加 `@manager.command`
# 如果需要多個參數，則定義多個 manager.option 即可
# 關於dest參數，實際測試的過程發現好像可有可無，官網建議還是帶上
@manager.option('-n', '--name', dest='name', default="DefaltName", help='name to say Hello')
@manager.option('-a', '--age', dest='age',  default=18, help='user age')
def sayHello(age, name):
    print(f"Hello {name}, you are {age} old")

# 給 manager 添加額外的參數
# 會在optional arguments中除了help之外，多出現一行 `-c CONFIG, --config CONFIG`
# 而且注意：
# manager.add_option 添加的參數是在 app.py 緊跟後面，注意和自定義命令的參數做區分
manager.add_option('-c', '--config', dest='config', required=False)


# 基於子類的方法定義自定義命令
# 需要配合 manager.add_command() 使用
class Hello(Command):
    def __init__(self, default_name='James', default_age=18):
        self.default_name = default_name
        self.default_age = default_age

    def get_options(self):
        """
        除了 get_options() 方法來獲取命令參數，也可以定義 option_list 變量
        option_list = (
            Option('-n', '--name', dest='name', default=self.default_name),
            Option('-a', '--age', dest='age', default=self.default_age)
        )
        """
        return [
            Option('-n', '--name', dest='name', default=self.default_name),
            Option('-a', '--age', dest='age', default=self.default_age)
        ]

    def hellp(self, name, age):
        print(f"Hello {name}, you are {age} old [From SubClass Command]")

manager.add_command('cHello', Hello())


if __name__ == '__main__':
    # 注意這裏被 manager.run()接管， 而不是app.run()
    manager.run()

代碼中都有詳細備註說明。大家可以閱讀註釋和自己實操一遍，應該就能掌握

執行結果展示:

直接執行 python app.py 不添加任何參數時

具體命令執行結果展示

# python app.py sayHi
Hi Flask-script

# python app.py sayHello
Hello DefaltName, you are 18 old

# python demo.py sayHello --name Betty --age 30
Hello Betty, you are 30 old

# python app.py CHello  --name Harry --age 31
Hello Harry, you're 31 old [From SubClass Command]

擴展

flask-script的作者也建議 從Flask 0.11開始，Flask包括一個內置CLI工具，這可能更適合您的需要

所以除了這個插件的學習，我們也可以瞭解下Flask內置CLI工具，官方文檔參考 https://flask.palletsprojects.com/en/2.2.x/cli/。

在實際開發中，視情況而選擇，後續介紹 Flask內置的CLI工具使用