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
|
#!/usr/bin/env python
# -*- coding: utf-8 -*-
# -----------------------------------------------------------------------------
# Copyright (c) 2009- Spyder Project Contributors
#
# Distributed under the terms of the MIT License
# (see spyder/__init__.py for details)
# -----------------------------------------------------------------------------
"""
Bootstrap Spyder.
Execute Spyder from source checkout.
"""
# Standard library imports
import argparse
import os
import shutil
import subprocess
import sys
import time
from logging import Formatter, StreamHandler, getLogger
from pathlib import Path
# Local imports
from install_dev_repos import DEVPATH, REPOS, install_repo
# =============================================================================
# ---- Setup logger
# =============================================================================
fmt = Formatter('%(asctime)s [%(levelname)s] [%(name)s] -> %(message)s')
h = StreamHandler()
h.setFormatter(fmt)
logger = getLogger('Bootstrap')
logger.addHandler(h)
logger.setLevel('INFO')
time_start = time.time()
# =============================================================================
# ---- Parse command line
# =============================================================================
parser = argparse.ArgumentParser(
usage="python bootstrap.py [options] [-- spyder_options]",
epilog="""\
Arguments for Spyder's main script are specified after the --
symbol (example: `python bootstrap.py -- --hide-console`).
Type `python bootstrap.py -- --help` to read about Spyder
options.""")
parser.add_argument('--gui', default=None,
help="GUI toolkit: pyqt5, pyside2, pyqt6 or pyside6")
parser.add_argument('--hide-console', action='store_true', default=False,
help="Hide parent console window (Windows only)")
parser.add_argument('--safe-mode', dest="safe_mode",
action='store_true', default=False,
help="Start Spyder with a clean configuration directory")
parser.add_argument('--debug', action='store_true',
default=False, help="Run Spyder in debug mode")
parser.add_argument('--filter-log', default='',
help="Comma-separated module name hierarchies whose log "
"messages should be shown. e.g., "
"spyder.plugins.completion,spyder.plugins.editor")
parser.add_argument('--no-install', action='store_true', default=False,
help="Do not install Spyder or its subrepos")
parser.add_argument('spyder_options', nargs='*')
args = parser.parse_args()
assert args.gui in (None, "pyqt5", "pyside2", "pyqt6", "pyside6"), (
"Invalid GUI toolkit option '%s'" % args.gui
)
# =============================================================================
# ---- Install sub repos
# =============================================================================
installed_dev_repo = False
if not args.no_install:
prev_branch = None
boot_branch_file = DEVPATH / ".boot_branch.txt"
if boot_branch_file.exists():
prev_branch = boot_branch_file.read_text()
result = subprocess.run(
["git", "-C", DEVPATH, "merge-base", "--fork-point", "master"],
capture_output=True
)
branch = "master" if result.stdout else "not master"
boot_branch_file.write_text(branch)
logger.info("Previous root branch: %s; current root branch: %s",
prev_branch, branch)
if branch != prev_branch:
logger.info("Detected root branch change to/from master. "
"Will reinstall Spyder in editable mode.")
REPOS[DEVPATH.name]["editable"] = False
for name in REPOS.keys():
# Don't install the spyder-remote-services subrepo because it's not
# necessary on the Spyder side.
if name != "spyder-remote-services":
if not REPOS[name]['editable']:
install_repo(name)
installed_dev_repo = True
else:
logger.info("%s installed in editable mode", name)
if installed_dev_repo:
logger.info("Restarting bootstrap to pick up installed subrepos")
if '--' in sys.argv:
sys.argv.insert(sys.argv.index('--'), '--no-install')
else:
sys.argv.append('--no-install')
result = subprocess.run([sys.executable, *sys.argv])
sys.exit(result.returncode)
# Local imports
# Must follow install_repo in case Spyder was not originally installed.
from spyder import get_versions
logger.info("Executing Spyder from source checkout")
# Prepare arguments for Spyder's main script
original_sys_argv = sys.argv.copy()
sys.argv = [sys.argv[0]] + args.spyder_options
# =============================================================================
# ---- Update os.environ
# =============================================================================
# Store variable to be used in self.restart (restart Spyder instance)
os.environ['SPYDER_BOOTSTRAP_ARGS'] = str(original_sys_argv[1:])
# Start Spyder with a clean configuration directory for testing purposes
if args.safe_mode:
os.environ['SPYDER_SAFE_MODE'] = 'True'
# To activate/deactivate certain things for development
os.environ['SPYDER_DEV'] = 'True'
if args.debug:
# safety check - Spyder config should not be imported at this point
if "spyder.config.base" in sys.modules:
sys.exit("ERROR: Can't enable debug mode - Spyder is already imported")
logger.info("Switching debug mode on")
os.environ["SPYDER_DEBUG"] = "3"
if len(args.filter_log) > 0:
logger.info("Displaying log messages only from the "
"following modules: %s", args.filter_log)
os.environ["SPYDER_FILTER_LOG"] = args.filter_log
# this way of interaction suxx, because there is no feedback
# if operation is successful
# Selecting the GUI toolkit: PyQt5 if installed
if args.gui is None:
try:
import PyQt5 # analysis:ignore
logger.info("PyQt5 is detected, selecting")
os.environ['QT_API'] = 'pyqt5'
except ImportError:
sys.exit("ERROR: No PyQt5 detected!")
else:
logger.info("Skipping GUI toolkit detection")
os.environ['QT_API'] = args.gui
# =============================================================================
# ---- Check versions
# =============================================================================
# Checking versions (among other things, this has the effect of setting the
# QT_API environment variable if this has not yet been done just above)
versions = get_versions(reporev=True)
logger.info("Imported Spyder %s - Revision %s, Branch: %s; "
"[Python %s %dbits, Qt %s, %s %s on %s]",
versions['spyder'], versions['revision'], versions['branch'],
versions['python'], versions['bitness'], versions['qt'],
versions['qt_api'], versions['qt_api_ver'], versions['system'])
# Check that we have the right qtpy version
from spyder.utils import programs
if not programs.is_module_installed('qtpy', '>=1.1.0'):
sys.exit("ERROR: Your qtpy version is outdated. Please install qtpy "
"1.1.0 or higher to be able to work with Spyder!")
# =============================================================================
# ---- Execute Spyder
# =============================================================================
if args.hide_console and os.name == 'nt':
logger.info("Hiding parent console (Windows only)")
sys.argv.append("--hide-console") # Windows only: show parent console
# Reset temporary config directory if starting in --safe-mode
if args.safe_mode or os.environ.get('SPYDER_SAFE_MODE'):
from spyder.config.base import get_conf_path # analysis:ignore
conf_dir = Path(get_conf_path())
if conf_dir.is_dir():
shutil.rmtree(conf_dir)
logger.info("Running Spyder")
from spyder.app import start # analysis:ignore
time_lapse = time.time() - time_start
logger.info("Bootstrap completed in %s%s",
time.strftime("%H:%M:%S.", time.gmtime(time_lapse)),
# gmtime() converts float into tuple, but loses milliseconds
("%.4f" % time_lapse).split('.')[1])
start.main()
|
