如何在 Python 中高效地提供 Web、CLI 和 API 接口？

Question

我的问题如下。我的库中有一些功能：

def some_func(arg1=1):
    pass

我想以三种方式使用它：

在其他 python 脚本中使用 import 语句：

import my_library
my_library.some_func()

使用 CLI 界面点击显示。

@click.group()
@click.option('--arg1', default=1)
def some_func(arg1):
    pass

使用带有 Flask 的 Web 界面公开。

@app.route('/endpoint', defaults={'arg1': 1})
def some_func(arg1):
    pass

但是如何在不复制太多代码的情况下有效地构建它呢？

是否可以合并所有三个？我尝试了以下（变体），但失败了：

@click.group()
@click.option('--arg1', default=1)
@app.route('/endpoint', defaults={'arg1': 1})
def some_func(arg1=1):
    pass

或者我真的需要上面定义的 3 个不同的功能吗？

如果是这样，我应该如何处理默认值？

在所有地方访问全局变量是最好的方法吗？

Answer 1

由于装饰器语法只是函数应用程序的快捷方式，因此您首先要在库中定义函数。那么你的click 例子就变成了：

import my_library

click.group()(click.option('--arg1', default=1)(my_library.some_func))

你的 Flask 例子变成了

import library

app.route('/endpoint', defaults={'arg1': 1})(my_library.some_func)

（我知道对于 Flask，装饰器的返回值并不重要；我假设 click 也是如此。）

这假设您没有尝试将相同的脚本用作命令行工具和 Flask 应用程序； IMO 没有多大意义。

---

就简化默认值而言，没有什么好的想法。 Click、Flask 和你的函数有三种不同的指示默认值的方式；唯一的共同点是该默认值的实际 value。你可能会做这样的事情。首先在my_library.py:

some_func_default = 1

def some_func(arg=None):  # Or some other sentinel
    if arg is None:
        arg = some_func_default

然后在你的另外两个脚本中：

click.group()(click.option('--arg1', default=my_library.some_func_default)(my_library.some_func))

和

app.route('/endpoint', defaults={'arg1': my_library.some_func_default})(my_library.some_func)

当然，您可以使用 inspect 模块从 some_func 的原始定义中提取默认值，但这无助于 Click 和 Flask 为其入口点设置默认值的方式的差异。

Answer 2

您可以使用专门为此用例制作的 hug 库。

例子：

"""An example of writing an API to scrape hacker news once, and then enabling usage everywhere"""
import hug
import requests


@hug.local()
@hug.cli()
@hug.get()
def top_post(section: hug.types.one_of(('news', 'newest', 'show'))='news'):
    """Returns the top post from the provided section"""
    content = requests.get('https://news.ycombinator.com/{0}'.format(section)).content
    text = content.decode('utf-8')
    return text.split('<tr class=\'athing\'>')[1].split("<a href")[1].split(">")[1].split("<")[0]