如何通过Poetry实现Python包安装时部署site-packages外的文件？

Poetry本身没有内置配置支持直接在site-packages目录外创建文件，但可以通过自定义安装钩子脚本实现需求，具体步骤如下：

1. 编写Post-Install脚本 #

创建post_install.py文件，实现桌面文件的生成逻辑：

import os
import sys
from pathlib import Path

def get_desktop_directory():
    # 判断安装类型，匹配对应桌面文件目录
    if sys.prefix == "/usr" or sys.prefix.startswith("/usr/local"):
        return Path("/usr/share/applications")
    else:
        return Path.home() / ".local/share/applications"

def create_desktop_file():
    desktop_dir = get_desktop_directory()
    # 确保目标目录存在
    desktop_dir.mkdir(parents=True, exist_ok=True)
    
    desktop_path = desktop_dir / "my-package.desktop"
    # 桌面文件内容，根据你的包需求修改
    desktop_content = """[Desktop Entry]
Type=Application
Name=My Package
Exec=my-package-script  # 替换为你通过tool.poetry.scripts定义的可执行命令
Icon=utilities-terminal
Comment=启动My Package应用
Terminal=true
Categories=Utility;Development;
"""
    
    with open(desktop_path, "w", encoding="utf-8") as f:
        f.write(desktop_content)
    print(f"已创建桌面文件：{desktop_path}")

if __name__ == "__main__":
    create_desktop_file()

2. 编写自定义安装钩子 #

创建build.py文件，通过setuptools自定义安装类，在安装完成后触发脚本：

from setuptools import setup
from setuptools.command.install import install

class CustomInstall(install):
    def run(self):
        # 先执行默认安装流程
        install.run(self)
        # 执行桌面文件生成逻辑
        import post_install
        post_install.create_desktop_file()

setup(
    cmdclass={"install": CustomInstall}
)

3. 配置Poetry项目 #

修改pyproject.toml，让Poetry使用自定义构建脚本，并包含必要文件：

[tool.poetry]
# ... 你的项目基础配置（名称、版本、作者等）
include = ["post_install.py", "build.py"]  # 确保脚本被打包到发行版

[tool.poetry.build]
script = "build.py"  # 指定自定义构建脚本

# 保留已定义的可执行脚本（对应桌面文件里的Exec命令）
[tool.poetry.scripts]
my-package-script = "my_package.main:main"

4. 构建并测试安装 #

执行以下命令构建包并安装：

poetry build
pip install dist/my-package-*.tar.gz

安装完成后，对应目录下会生成my-package.desktop文件。

注意事项 #

• 用sudo pip install进行系统级安装时，桌面文件会生成到/usr/share/applications，需确保脚本有写入权限；用户级安装则写入~/.local/share/applications，无需额外权限。
• 桌面文件的Icon字段需替换为应用实际图标路径或系统内置图标名称，否则会显示默认图标。

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