如何安排一个函数在 Flask 上每小时运行一次？

您可以使用 APScheduler 包 (v3.5.3) 中的 BackgroundScheduler()：

import time
import atexit

from apscheduler.schedulers.background import BackgroundScheduler


def print_date_time():
    print(time.strftime("%A, %d. %B %Y %I:%M:%S %p"))


scheduler = BackgroundScheduler()
scheduler.add_job(func=print_date_time, trigger="interval", seconds=60)
scheduler.start()

# Shut down the scheduler when exiting the app
atexit.register(lambda: scheduler.shutdown())

请注意，当 Flask 处于调试模式时，将启动其中两个调度程序。有关详细信息，请查看 this 问题。

---

我对应用程序调度程序的概念有点陌生，但我在这里找到的 APScheduler v3.3.1 有点不同。我相信对于最新版本，包结构、类名等都发生了变化，所以我在这里放了一个我最近制作的新解决方案，它与基本的 Flask 应用程序集成：

#!/usr/bin/python3
""" Demonstrating Flask, using APScheduler. """

from apscheduler.schedulers.background import BackgroundScheduler
from flask import Flask

def sensor():
    """ Function for test purposes. """
    print("Scheduler is alive!")

sched = BackgroundScheduler(daemon=True)
sched.add_job(sensor,'interval',minutes=60)
sched.start()

app = Flask(__name__)

@app.route("/home")
def home():
    """ Function for test purposes. """
    return "Welcome Home :) !"

if __name__ == "__main__":
    app.run()

如果有人对此示例的更新感兴趣，我也将离开此 Gist here。

以下是一些参考资料，供将来阅读：

APScheduler 文档：https://apscheduler.readthedocs.io/en/latest/

守护进程=真：https://docs.python.org/3.4/library/threading.html#thread-objects

---

您可以在 Flask 应用程序中使用 APScheduler 并通过其界面运行您的作业：

import atexit

# v2.x version - see https://stackoverflow.com/a/38501429/135978
# for the 3.x version
from apscheduler.scheduler import Scheduler
from flask import Flask

app = Flask(__name__)

cron = Scheduler(daemon=True)
# Explicitly kick off the background thread
cron.start()

@cron.interval_schedule(hours=1)
def job_function():
    # Do your work here


# Shutdown your cron thread if the web process is stopped
atexit.register(lambda: cron.shutdown(wait=False))

if __name__ == '__main__':
    app.run()

---

我试过使用烧瓶而不是简单的 apscheduler 你需要安装的是

pip3 安装 flask_apscheduler

以下是我的代码示例：

from flask import Flask
from flask_apscheduler import APScheduler

app = Flask(__name__)
scheduler = APScheduler()

def scheduleTask():
    print("This test runs every 3 seconds")

if __name__ == '__main__':
    scheduler.add_job(id = 'Scheduled Task', func=scheduleTask, trigger="interval", seconds=3)
    scheduler.start()
    app.run(host="0.0.0.0")

---

对于一个简单的解决方案，您可以添加一条路线，例如

@app.route("/cron/do_the_thing", methods=['POST'])
def do_the_thing():
    logging.info("Did the thing")
    return "OK", 200

然后 add a unix cron job 定期发布到此端点。例如，要每分钟运行一次，在终端输入 crontab -e 并添加以下行：

* * * * * /opt/local/bin/curl -X POST https://YOUR_APP/cron/do_the_thing

（请注意，curl 的路径必须完整，因为当作业运行时它不会有您的 PATH。您可以通过 which curl 找到系统上 curl 的完整路径）

我喜欢这个，因为它很容易手动测试作业，它没有额外的依赖项，并且没有任何特别的事情发生，很容易理解。

安全

如果您想用密码保护您的 cron 作业，您可以 pip install Flask-BasicAuth，然后将凭据添加到您的应用配置中：

app = Flask(__name__)
app.config['BASIC_AUTH_REALM'] = 'realm'
app.config['BASIC_AUTH_USERNAME'] = 'falken'
app.config['BASIC_AUTH_PASSWORD'] = 'joshua'

要密码保护作业端点：

from flask_basicauth import BasicAuth
basic_auth = BasicAuth(app)

@app.route("/cron/do_the_thing", methods=['POST'])
@basic_auth.required
def do_the_thing():
    logging.info("Did the thing a bit more securely")
    return "OK", 200

然后从您的 cron 作业中调用它：

* * * * * /opt/local/bin/curl -X POST https://falken:joshua@YOUR_APP/cron/do_the_thing

---

您可以尝试使用 APScheduler's BackgroundScheduler 将间隔作业集成到您的 Flask 应用程序中。下面是使用蓝图和应用工厂 (init.py) 的示例：

from datetime import datetime

# import BackgroundScheduler
from apscheduler.schedulers.background import BackgroundScheduler
from flask import Flask

from webapp.models.main import db 
from webapp.controllers.main import main_blueprint    

# define the job
def hello_job():
    print('Hello Job! The time is: %s' % datetime.now())

def create_app(object_name):
    app = Flask(__name__)
    app.config.from_object(object_name)
    db.init_app(app)
    app.register_blueprint(main_blueprint)
    # init BackgroundScheduler job
    scheduler = BackgroundScheduler()
    # in your case you could change seconds to hours
    scheduler.add_job(hello_job, trigger='interval', seconds=3)
    scheduler.start()

    try:
        # To keep the main thread alive
        return app
    except:
        # shutdown if app occurs except 
        scheduler.shutdown()

希望能帮助到你 ：）

参考：

https://github.com/agronholm/apscheduler/blob/master/examples/schedulers/background.py

---

另一种选择可能是使用与 Flask 配合得很好的 Flask-APScheduler，例如：

从 Flask 配置加载调度程序配置，

从 Flask 配置加载作业定义

更多信息在这里：

https://pypi.python.org/pypi/Flask-APScheduler

---

使用调度和多处理的完整示例，具有开和关控制以及 run_job() 的参数，返回代码被简化，间隔设置为 10 秒，更改为 every(2).hour.do() 2 小时。时间表非常令人印象深刻，它不会漂移，而且我在安排时从未见过它超过 100 毫秒。使用多处理而不是线程，因为它有一个终止方法。

#!/usr/bin/env python3

import schedule
import time
import datetime
import uuid

from flask import Flask, request
from multiprocessing import Process

app = Flask(__name__)
t = None
job_timer = None

def run_job(id):
    """ sample job with parameter """
    global job_timer
    print("timer job id={}".format(id))
    print("timer: {:.4f}sec".format(time.time() - job_timer))
    job_timer = time.time()

def run_schedule():
    """ infinite loop for schedule """
    global job_timer
    job_timer = time.time()
    while 1:
        schedule.run_pending()
        time.sleep(1)

@app.route('/timer/<string:status>')
def mytimer(status, nsec=10):
    global t, job_timer
    if status=='on' and not t:
        schedule.every(nsec).seconds.do(run_job, str(uuid.uuid4()))
        t = Process(target=run_schedule)
        t.start()
        return "timer on with interval:{}sec\n".format(nsec)
    elif status=='off' and t:
        if t:
            t.terminate()
            t = None
            schedule.clear()
        return "timer off\n"
    return "timer status not changed\n"

if __name__ == '__main__':
    app.run(host='0.0.0.0', port=5000)

您只需发出以下命令即可对此进行测试：

$ curl http://127.0.0.1:5000/timer/on
timer on with interval:10sec
$ curl http://127.0.0.1:5000/timer/on
timer status not changed
$ curl http://127.0.0.1:5000/timer/off
timer off
$ curl http://127.0.0.1:5000/timer/off
timer status not changed

定时器每 10 秒开启一次，它会向控制台发出一条定时器消息：

127.0.0.1 - - [18/Sep/2018 21:20:14] "GET /timer/on HTTP/1.1" 200 -
timer job id=b64ed165-911f-4b47-beed-0d023ead0a33
timer: 10.0117sec
timer job id=b64ed165-911f-4b47-beed-0d023ead0a33
timer: 10.0102sec

---

您可以使用 flask-crontab 模块，这很简单。

第 1 步：pip install flask-crontab

第2步：

from flask import Flask
from flask_crontab import Crontab

app = Flask(__name__)
crontab = Crontab(app)

第 3 步：

@crontab.job(minute="0", hour="6", day="*", month="*", day_of_week="*")
def my_scheduled_job():
    do_something()

第4步：在cmd上，点击

flask crontab add

完毕。现在只需运行您的烧瓶应用程序，您就可以检查您的函数将在每天 6:00 调用。

您可以参考Here（官方文档）。

---

您可能希望将一些队列机制与诸如 RQ scheduler 之类的调度程序或诸如 Celery 之类的更重的东西一起使用（很可能是矫枉过正）。

---