entry_points/console_scripts和setup.py中的脚本之间的区别？

Question

基本上有两种方法可以将Python控制台脚本安装到我的路径中setup.py:

setup(
    ...
    entry_points = {
        'console_scripts': [
            'foo = package.module:func',
        ],
    }
)

和

setup(
    ...
    scripts = [
        'scripts/myscript.sh'
    ]
)

有什么区别？我看到第一种方法允许我为我的脚本选择不错的特定名称,但是还有其他差异吗？不同的原始用途,兼容性(setuptools,distutils,......？),用法,......？我很困惑,一个精心设计的回复可以帮助我(也可能还有其他人)正确理解这一切.

更新:因为我问过PyPA 在这个主题上发表了这些很酷的文档.

Answer 1

(真棒)Click包的文档提出了使用入口点而不是脚本的几个原因,包括

1. 跨平台兼容性和
2. 避免将解释器分配__name__给__main__,这可能导致代码被导入两次(如果另一个模块导入你的脚本)

Click是一种实现函数的好方法,可以用作entry_pointsbtw.

Answer 2

这两种创建命令行可执行文件的方法之间的一个关键区别是,使用该setuptools方法(您的第一个示例),您必须在脚本内部调用一个函数 - 在您的情况下,这是func您的内部module.但是,在distutils方法(您的第二个示例)中,您可以直接调用脚本(允许使用或不使用扩展名列出).

Answer 3

设置工具入口点方法(#1)还具有以下优点:在Windows上将创建可以双击并像常规Windows程序一样调用的.exe.这是在类似posix的系统上将脚本放置在bin路径中的补充.

Answer 4

另一个区别是，当使用 console_scripts 时，我的模块__init__文件被运行。当只使用脚本时，模块__init__不运行，只运行脚本。