/
environ.py
259 lines (215 loc) · 8.01 KB
/
environ.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
# -*- coding: utf-8 -*-
#
# Copyright © Spyder Project Contributors
# Licensed under the terms of the MIT License
# (see spyder/__init__.py for details)
"""
Environment variable utilities.
"""
# Standard library imports
import os
from pathlib import Path
import re
import sys
try:
import winreg
except Exception:
pass
# Third party imports
from qtpy.QtWidgets import QMessageBox
# Local imports
from spyder.config.base import _, running_in_ci, running_in_mac_app
from spyder.widgets.collectionseditor import CollectionsEditor
from spyder.utils.icon_manager import ima
from spyder.utils.programs import run_shell_command
def envdict2listdict(envdict):
"""Dict --> Dict of lists"""
sep = os.path.pathsep
for key, val in envdict.items():
if isinstance(val, str) and sep in val:
envdict[key] = [path.strip() for path in val.split(sep)]
return envdict
def listdict2envdict(listdict):
"""Dict of lists --> Dict"""
for key, val in listdict.items():
if isinstance(val, list):
listdict[key] = os.path.pathsep.join(val)
return listdict
def get_user_environment_variables():
"""
Get user environment variables from a subprocess.
Returns
-------
env_var : dict
Key-value pairs of environment variables.
"""
try:
if os.name == 'nt':
key = winreg.OpenKey(winreg.HKEY_CURRENT_USER, "Environment")
num_values = winreg.QueryInfoKey(key)[1]
env_var = dict(
[winreg.EnumValue(key, k)[:2] for k in range(num_values)]
)
else:
shell = os.environ.get("SHELL", "/bin/bash")
cmd = (
f"{shell} -l -c"
f""" "{sys.executable} -c 'import os; print(dict(os.environ))'" """
)
if running_in_mac_app():
env = {"PYTHONHOME": os.environ["PYTHONHOME"]}
else:
env = {}
proc = run_shell_command(cmd, env=env, text=True)
# Use timeout to fix spyder-ide/spyder#21172
stdout, stderr = proc.communicate(timeout=0.5)
env_var = eval(stdout, None)
except Exception:
return {}
return env_var
def get_user_env():
"""Return current user environment variables with parsed values"""
env_dict = get_user_environment_variables()
return envdict2listdict(env_dict)
def set_user_env(env, parent=None):
"""
Set user environment variables via HKCU (Windows) or shell startup file
(Unix).
"""
env_dict = listdict2envdict(env)
if os.name == 'nt':
types = dict()
key = winreg.OpenKey(winreg.HKEY_CURRENT_USER, "Environment")
for name in env_dict:
try:
_x, types[name] = winreg.QueryValueEx(key, name)
except WindowsError:
types[name] = winreg.REG_EXPAND_SZ
key = winreg.OpenKey(winreg.HKEY_CURRENT_USER, "Environment", 0,
winreg.KEY_SET_VALUE)
for name in env_dict:
winreg.SetValueEx(key, name, 0, types[name], env_dict[name])
try:
from win32gui import SendMessageTimeout
from win32con import (HWND_BROADCAST, WM_SETTINGCHANGE,
SMTO_ABORTIFHUNG)
SendMessageTimeout(HWND_BROADCAST, WM_SETTINGCHANGE, 0,
"Environment", SMTO_ABORTIFHUNG, 5000)
except Exception:
QMessageBox.warning(
parent, _("Warning"),
_("Module <b>pywin32 was not found</b>.<br>"
"Please restart this Windows <i>session</i> "
"(not the computer) for changes to take effect.")
)
elif os.name == 'posix' and running_in_ci():
text = "\n".join([f"export {k}={v}" for k, v in env_dict.items()])
amend_user_shell_init(text)
else:
raise NotImplementedError("Not implemented for platform %s", os.name)
def amend_user_shell_init(text="", restore=False):
"""Set user environment variable for pytests on Unix platforms"""
if os.name == "nt":
return
HOME = Path(os.environ["HOME"])
SHELL = os.environ.get("SHELL", "/bin/bash")
if "bash" in SHELL:
init_files = [".bash_profile", ".bash_login", ".profile"]
elif "zsh" in SHELL:
init_files = [".zprofile", ".zshrc"]
else:
raise Exception(f"{SHELL} not supported.")
for file in init_files:
init_file = HOME / file
if init_file.exists():
break
script = init_file.read_text() if init_file.exists() else ""
m1 = "# <<<< Spyder Environment <<<<"
m2 = "# >>>> Spyder Environment >>>>"
if restore:
if init_file.exists() and (m1 in script and m2 in script):
new_text = ""
else:
return
else:
new_text = f"{m1}\n" + text + f"\n{m2}"
if m1 in script and m2 in script:
_script = re.sub(f"{m1}(.*){m2}", new_text, script, flags=re.DOTALL)
else:
_script = script.rstrip() + "\n\n" + new_text
init_file.write_text(_script.rstrip() + "\n")
def clean_env(env_vars):
"""
Remove non-ascii entries from a dictionary of environments variables.
The values will be converted to strings or bytes (on Python 2). If an
exception is raised, an empty string will be used.
"""
new_env_vars = env_vars.copy()
for key, var in env_vars.items():
new_env_vars[key] = str(var)
return new_env_vars
class RemoteEnvDialog(CollectionsEditor):
"""Remote process environment variables dialog."""
def __init__(self, environ, parent=None,
title=_("Environment variables"), readonly=True):
super().__init__(parent)
try:
self.setup(
envdict2listdict(environ),
title=title,
readonly=readonly,
icon=ima.icon('environ')
)
except Exception as e:
QMessageBox.warning(
parent,
_("Warning"),
_("An error occurred while trying to show your "
"environment variables. The error was<br><br>"
"<tt>{0}</tt>").format(e),
QMessageBox.Ok
)
class EnvDialog(RemoteEnvDialog):
"""Environment variables Dialog"""
def __init__(self, parent=None):
RemoteEnvDialog.__init__(self, dict(os.environ), parent=parent)
class UserEnvDialog(RemoteEnvDialog):
"""User Environment Variables Viewer/Editor"""
def __init__(self, parent=None):
title = _("User environment variables")
readonly = True
if os.name == 'nt':
title = _(r"User environment variables in Windows registry")
readonly = False
super().__init__(get_user_env(), parent, title, readonly)
if os.name == 'nt':
if parent is None:
parent = self
QMessageBox.warning(
parent, _("Warning"),
_("If you accept changes, "
"this will modify the current user environment "
"variables directly <b>in Windows registry</b>. "
"Use it with precautions, at your own risks.<br>"
"<br>Note that for changes to take effect, you will "
"need to restart the parent process of this applica"
"tion (simply restart Spyder if you have executed it "
"from a Windows shortcut, otherwise restart any "
"application from which you may have executed it, "
"like <i>Python(x,y) Home</i> for example)")
)
def accept(self):
"""Reimplement Qt method"""
if os.name == 'nt':
set_user_env(listdict2envdict(self.get_value()), parent=self)
super().accept()
def test():
"""Run Windows environment variable editor"""
import sys
from spyder.utils.qthelpers import qapplication
_ = qapplication()
dlg = UserEnvDialog()
dlg.show()
sys.exit(dlg.exec())
if __name__ == "__main__":
test()