从Python修改Windows环境变量的接口

Question

如何从Python脚本持久地修改Windows环境变量？（这是setup.py脚本）

我正在寻找一个标准的功能或模块来使用这个。我已经对registry way of doing it很熟悉了，但是也欢迎对此发表任何评论。

Answer 1

使用setx有一些缺点，特别是当您试图附加到环境变量（例如setx PATH%PATH%；C:\ mypath）时，这将在每次运行时重复附加到路径，这可能是一个问题。更糟糕的是，它无法区分机器路径（存储在HKEY_LOCAL_machine中）和用户路径（存储在HKEY_CURRENT_user中）。在命令提示下看到的环境变量由这两个值的串联组成。因此，在调用setx之前：

user PATH == u
machine PATH == m
%PATH% == m;u

> setx PATH %PATH%;new

Calling setx sets the USER path by default, hence now:
user PATH == m;u;new
machine PATH == m
%PATH% == m;m;u;new

每次调用setx追加到path时，%path%环境变量中的系统路径不可避免地重复。这些更改是永久性的，不会通过重新启动来重置，因此会在机器的整个生命周期中累积。

我无法在DOS中弥补这一点。所以我转向了Python。我今天提出的解决方案是，通过调整注册表来设置环境变量，包括在不引入重复项的情况下附加到PATH，如下所示：

from os import system, environ
import win32con
from win32gui import SendMessage
from _winreg import (
    CloseKey, OpenKey, QueryValueEx, SetValueEx,
    HKEY_CURRENT_USER, HKEY_LOCAL_MACHINE,
    KEY_ALL_ACCESS, KEY_READ, REG_EXPAND_SZ, REG_SZ
)

def env_keys(user=True):
    if user:
        root = HKEY_CURRENT_USER
        subkey = 'Environment'
    else:
        root = HKEY_LOCAL_MACHINE
        subkey = r'SYSTEM\CurrentControlSet\Control\Session Manager\Environment'
    return root, subkey


def get_env(name, user=True):
    root, subkey = env_keys(user)
    key = OpenKey(root, subkey, 0, KEY_READ)
    try:
        value, _ = QueryValueEx(key, name)
    except WindowsError:
        return ''
    return value


def set_env(name, value):
    key = OpenKey(HKEY_CURRENT_USER, 'Environment', 0, KEY_ALL_ACCESS)
    SetValueEx(key, name, 0, REG_EXPAND_SZ, value)
    CloseKey(key)
    SendMessage(
        win32con.HWND_BROADCAST, win32con.WM_SETTINGCHANGE, 0, 'Environment')


def remove(paths, value):
    while value in paths:
        paths.remove(value)


def unique(paths):
    unique = []
    for value in paths:
        if value not in unique:
            unique.append(value)
    return unique


def prepend_env(name, values):
    for value in values:
        paths = get_env(name).split(';')
        remove(paths, '')
        paths = unique(paths)
        remove(paths, value)
        paths.insert(0, value)
        set_env(name, ';'.join(paths))


def prepend_env_pathext(values):
    prepend_env('PathExt_User', values)
    pathext = ';'.join([
        get_env('PathExt_User'),
        get_env('PathExt', user=False)
    ])
    set_env('PathExt', pathext)



set_env('Home', '%HomeDrive%%HomePath%')
set_env('Docs', '%HomeDrive%%HomePath%\docs')
set_env('Prompt', '$P$_$G$S')

prepend_env('Path', [
    r'%SystemDrive%\cygwin\bin', # Add cygwin binaries to path
    r'%HomeDrive%%HomePath%\bin', # shortcuts and 'pass-through' bat files
    r'%HomeDrive%%HomePath%\docs\bin\mswin', # copies of standalone executables
])

# allow running of these filetypes without having to type the extension
prepend_env_pathext(['.lnk', '.exe.lnk', '.py'])

它不会影响当前进程或父shell，但会影响运行后打开的所有cmd窗口，而无需重新启动，并且可以安全地多次编辑和重新运行，而不会引入任何重复项。