setup.py配置console_script无法链接本地脚本的解决方案咨询

问题根源分析 #

1. console_scripts导入失败：你用bin.C2C:main作为导入路径，但bin目录不是合法的Python包（缺少__init__.py文件），Python解释器无法识别这个模块路径，因此抛出ModuleNotFoundError: No module named 'bin'。
2. scripts选项的弊端：scripts=['bin/C2C']会把脚本文件复制到conda环境的bin目录，而非创建实时链接，所以修改原脚本后不会立即生效；同时脚本中的相对路径会以环境bin目录为基准，而非原脚本所在的root/bin，导致路径逻辑混乱。

解决方案 #

方案一：将bin目录转为Python包（最小改动） #

1. 在root/bin目录下创建空的__init__.py文件，让bin成为可导入的Python包：

   root
     |--bin
         |-- __init__.py
         |-- C2C
     |--setup.py  
     |--(Rest of the package ... )
   

2. 保留原entry_points配置，重新执行可编辑安装：

   setup(
       ...
       entry_points={
           'console_scripts': ['c2c = bin.C2C:main']
       },
       ...
   )
   

   pip install -e .
   

3. 修复相对路径问题：在C2C脚本中，不要直接使用相对路径保存结果，而是通过脚本自身路径计算绝对路径。示例：

   import os
   # 获取脚本所在目录的绝对路径
   script_dir = os.path.dirname(os.path.abspath(__file__))
   # 基于此路径拼接结果保存路径
   result_path = os.path.join(script_dir, 'results', 'output.txt')
   

方案二：调整包结构（更规范的Python包做法） #

将可执行脚本整合到主包目录下，这是Python包的标准组织方式：

1. 调整目录结构（假设你的主包名为c2c_core）：

   root
     |--c2c_core
         |-- __init__.py
         |-- cli.py  # 将原C2C脚本内容迁移到这里
     |--setup.py  
     |--(Rest of the package ... )
   

2. 修改setup.py的entry_points配置：

   setup(
       ...
       entry_points={
           'console_scripts': ['c2c = c2c_core.cli:main']
       },
       ...
   )
   

3. 重新执行pip install -e .，此时c2c命令会动态导入c2c_core.cli中的main函数，修改原代码会实时生效；路径问题同样可以通过os.path.dirname(os.path.abspath(__file__))基于包目录处理。

方案有效性说明 #

• console_scripts生成的命令脚本是动态导入指定函数的，而非复制原脚本，因此在可编辑安装模式下，代码修改会立即生效。
• 转为合法Python包后，Python解释器可以正确识别模块路径，彻底解决导入错误问题。

内容的提问来源于stack exchange，提问作者Malte Jensen