如何跨平台实现PyPI包猴子补丁`python --version`命令及卸载恢复？

嘿，这个需求挺有意思的——要做一个能猴子补丁python --version的PyPI包，还得跨平台、卸载后恢复，对吧？我来一步步给你拆解实现思路和具体代码：

首先得搞清楚：python --version是Python解释器本身直接处理的命令行参数，直接去补丁Python的核心模块不仅麻烦，还容易搞崩环境。所以咱们换个更稳妥的思路——用自定义脚本替换系统PATH里的python/python3命令，先拦截参数：如果是--version或者-v就输出自定义内容，其他情况直接转发给真实的Python解释器。这样既安全，又能实现需求，还能跨平台。

1. 编写跨平台的拦截脚本 #

我们需要针对类Unix（Linux/macOS）和Windows系统分别做适配，因为它们的命令执行逻辑不一样。

类Unix系统（Linux/macOS）：可执行脚本 python-wrapper #

这个脚本要带shebang头，让系统知道用Python执行它：

#!/usr/bin/env python3
import sys
import subprocess

# 拿到真实的Python解释器路径（避免递归调用自己）
real_python = sys.executable
args = sys.argv[1:]

# 判断是否是版本查询请求
# 注意：Python原生的`-v`是verbose模式，这里按需求强制把`-v`当成版本查询，记得在文档里说明这个冲突
if args == ['--version'] or args == ['-v']:
    # 这里替换成你想要的自定义输出
    print("Custom Python Version: 9.9.9 (Monkey Patched by My Package)")
else:
    # 其他命令直接转发给真实Python
    subprocess.run([real_python] + args, check=False)

Windows系统：双文件组合 #

Windows下需要用bat脚本拦截命令，再调用Python脚本处理逻辑：

• 逻辑脚本 python-wrapper.py（和类Unix的核心逻辑一致）：

import sys
import subprocess

real_python = sys.executable
args = sys.argv[1:]

if args == ['--version'] or args == ['-v']:
    print("Custom Python Version: 9.9.9 (Monkey Patched by My Package)")
else:
    subprocess.run([real_python] + args, check=False)

• 拦截python命令的bat脚本 python.bat：

@echo off
python-wrapper.py %*

• 拦截python3命令的bat脚本 python3.bat：

@echo off
python-wrapper.py %*

2. 用setuptools编写安装/卸载逻辑 #

核心是在安装时备份原有的python命令，替换成我们的脚本；卸载时恢复原命令。我们通过自定义install和uninstall命令来实现这个逻辑，写在setup.py里：

from setuptools import setup, Command
import os
import shutil
import sys

# 自定义安装命令：备份原命令+替换成我们的脚本
class CustomInstall(Command):
    description = 'Install package and patch python command'
    user_options = []

    def initialize_options(self):
        pass

    def finalize_options(self):
        pass

    def run(self):
        # 先执行默认的pip安装流程
        self.run_command('install')

        # 分平台处理备份和替换
        if sys.platform.startswith('win'):
            # Windows下，Python命令通常在Scripts目录
            scripts_dir = os.path.join(sys.prefix, 'Scripts')
            for cmd in ['python.exe', 'python3.exe']:
                cmd_path = os.path.join(scripts_dir, cmd)
                if os.path.exists(cmd_path):
                    # 备份原exe
                    shutil.copy(cmd_path, f"{cmd_path}.backup")
                    # 复制我们的bat文件到Scripts目录（会覆盖原有bat，如果有的话）
                    shutil.copy(f"{cmd.split('.')[0]}.bat", scripts_dir)
        else:
            # 类Unix系统，用which命令找真实的python路径
            import subprocess
            for cmd in ['python', 'python3']:
                try:
                    real_cmd_path = subprocess.check_output(['which', cmd]).decode().strip()
                    if os.path.exists(real_cmd_path):
                        # 备份原命令
                        shutil.copy(real_cmd_path, f"{real_cmd_path}.backup")
                        # 复制我们的wrapper脚本替换原命令
                        shutil.copy('python-wrapper', real_cmd_path)
                        # 给脚本加可执行权限
                        os.chmod(real_cmd_path, 0o755)
                except subprocess.CalledProcessError:
                    print(f"Warning: Could not find {cmd} command to patch")

# 自定义卸载命令：恢复原命令+清理我们的脚本
class CustomUninstall(Command):
    description = 'Uninstall package and restore original python command'
    user_options = []

    def initialize_options(self):
        pass

    def finalize_options(self):
        pass

    def run(self):
        # 先恢复原命令
        if sys.platform.startswith('win'):
            scripts_dir = os.path.join(sys.prefix, 'Scripts')
            for cmd in ['python.exe', 'python3.exe']:
                cmd_path = os.path.join(scripts_dir, cmd)
                backup_path = f"{cmd_path}.backup"
                if os.path.exists(backup_path):
                    # 恢复原exe
                    shutil.move(backup_path, cmd_path)
                # 删除我们的bat文件
                bat_path = os.path.join(scripts_dir, f"{cmd.split('.')[0]}.bat")
                if os.path.exists(bat_path):
                    os.remove(bat_path)
        else:
            import subprocess
            for cmd in ['python', 'python3']:
                try:
                    real_cmd_path = subprocess.check_output(['which', cmd]).decode().strip()
                    backup_path = f"{real_cmd_path}.backup"
                    if os.path.exists(backup_path):
                        # 恢复原命令
                        shutil.move(backup_path, real_cmd_path)
                except subprocess.CalledProcessError:
                    print(f"Warning: Could not find backup for {cmd} to restore")
        # 执行默认的pip卸载流程
        self.run_command('uninstall')

setup(
    name="python-version-patcher",
    version="0.1.0",
    scripts=['python-wrapper', 'python-wrapper.py', 'python.bat', 'python3.bat'],
    cmdclass={
        'install': CustomInstall,
        'uninstall': CustomUninstall,
    },
    author="Your Name",
    description="Monkey patch python --version to show custom output",
    packages=[],  # 因为没有Python包模块，所以留空
)

3. 关键注意事项和优化点 #

• 权限问题：类Unix系统下，修改系统级的python命令（比如/usr/bin/python）需要sudo权限。建议用户用pip install --user安装，这样只会修改用户目录下的~/.local/bin/python，不需要sudo，更安全。
• 参数冲突：Python原生的-v是开启verbose模式，我们这里强制把-v当成版本查询，会覆盖原生行为。最好在包的README里明确说明这一点，或者改成只处理--version和-V（大写），避免干扰用户的正常使用。
• 真实路径准确性：用sys.executable获取真实Python路径是可靠的，因为pip安装时就是用目标解释器运行的setup.py。
• 跨平台测试：一定要在Windows、Linux、macOS分别测试安装、卸载后的行为，确保恢复正常。
• PyPI上传：需要编写pyproject.toml配置构建依赖（比如指定setuptools版本），然后用twine上传到PyPI。

1. 本地测试安装：pip install .
2. 验证效果：执行python --version和python -v，应该输出自定义内容；执行python -c "print('hello world')"，应该正常运行。
3. 卸载验证：pip uninstall python-version-patcher，再执行python --version，应该恢复原有的Python版本输出。

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