python - Python 命令行脚本中 'script' 与 'entry_point' 的优缺点

Question

Python 的 setuptool有两种向 Python 包添加命令行脚本的方法:script 和 entry_point。

This tutorial概述了这些方式:

脚本

将 Python 脚本 (funniest-joke) 添加到包树中，并将其路径添加到 setup.py:

setup(
    ...
    scripts=['bin/funniest-joke'],
    ...
)

入口点:

将 Python 脚本(funnie-joke)添加到包树中。添加一个 main() 函数，并添加运行最有趣的 main() 的 command_line.py 子模块:

command_line.py:

import funniest

def main():
    print funniest.joke()

setup.py

setup(
    ...
    entry_points = {
        'console_scripts': ['funniest-joke=funniest.command_line:main'],
    }
    ...
)

每种方法的优缺点是什么？

Answer 1

基本上，脚本是一种旧方法，它要求您拥有一个独立的可执行脚本文件，而入口点方法允许您定义在给出命令时要运行哪些函数。这样，您可以在同一个文件/模块中拥有多个函数，然后在用户键入 console_scripts 命令之一时调用“入口点”。

Although setup() supports a scripts keyword for pointing to pre-made scripts to install, the recommended approach to achieve cross-platform compatibility is to use console_scripts entry points (see below).

来自 https://packaging.python.org/tutorials/distributing-packages/#scripts (old source)