forked from jupyterlab/jupyterlab
-
Notifications
You must be signed in to change notification settings - Fork 0
/
setupbase.py
254 lines (203 loc) · 7.84 KB
/
setupbase.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
# encoding: utf-8
"""
This module defines the things that are used in setup.py for building JupyterLab
This includes:
* Functions for finding things like packages, package data, etc.
* A function for checking dependencies.
"""
# Copyright (c) Jupyter Development Team.
# Distributed under the terms of the Modified BSD License.
import io
import json
import os
import glob
import pipes
import sys
import shutil
import os.path as osp
from os.path import join as pjoin
from distutils import log
from distutils.cmd import Command
from distutils.version import LooseVersion
from setuptools.command.bdist_egg import bdist_egg
from subprocess import check_call
if sys.platform == 'win32':
from subprocess import list2cmdline
else:
def list2cmdline(cmd_list):
return ' '.join(map(pipes.quote, cmd_list))
# the name of the project
name = 'jupyterlab'
here = osp.dirname(osp.abspath(__file__))
is_repo = osp.exists(pjoin(here, '.git'))
version_ns = {}
with io.open(pjoin(here, name, '_version.py'), encoding="utf8") as f:
exec(f.read(), {}, version_ns)
def run(cmd, *args, **kwargs):
"""Echo a command before running it"""
log.info('> ' + list2cmdline(cmd))
kwargs['shell'] = (sys.platform == 'win32')
return check_call(cmd, *args, **kwargs)
#---------------------------------------------------------------------------
# Find packages
#---------------------------------------------------------------------------
def find_packages():
"""
Find all of the packages.
"""
packages = []
for dir, subdirs, files in os.walk('jupyterlab'):
package = dir.replace(osp.sep, '.')
if '__init__.py' not in files:
# not a package
continue
packages.append(package)
return packages
#---------------------------------------------------------------------------
# Find package data
#---------------------------------------------------------------------------
def find_package_data():
"""
Find package_data.
"""
theme_dirs = []
for dir, subdirs, files in os.walk(pjoin('jupyterlab', 'themes')):
slice_len = len('jupyterlab' + os.sep)
theme_dirs.append(pjoin(dir[slice_len:], '*'))
return {
'jupyterlab': ['build/*', 'schemas/*', 'index.app.js',
'webpack.config.js', 'package.app.json',
'released_packages.txt', 'node-version-check.js'] + theme_dirs
}
def ensure_core_data(command):
"""decorator for building minified js/css prior to another command"""
class DecoratedCommand(command):
def run(self):
coredeps = self.distribution.get_command_obj('coredeps')
if not is_repo and all(osp.exists(t) for t in coredeps.targets):
# build_py or build_ext, nothing to do
command.run(self)
return
try:
self.distribution.run_command('coredeps')
except Exception as e:
missing = [t for t in coredeps.targets if not osp.exists(t)]
if missing:
log.warn('file check failed')
if missing:
log.error('missing files: %s' % missing)
raise e
else:
log.warn('core deps check failed (not a problem)')
log.warn(str(e))
command.run(self)
return DecoratedCommand
def js_prerelease(command, strict=False):
"""decorator for building minified js/css prior to another command"""
class DecoratedCommand(command):
def run(self):
jsdeps = self.distribution.get_command_obj('jsdeps')
if not is_repo and all(osp.exists(t) for t in jsdeps.targets):
# sdist, nothing to do
command.run(self)
return
try:
self.distribution.run_command('jsdeps')
except Exception as e:
missing = [t for t in jsdeps.targets if not osp.exists(t)]
if strict or missing:
log.warn('js check failed')
if missing:
log.error('missing files: %s' % missing)
raise e
else:
log.warn('js check failed (not a problem)')
log.warn(str(e))
command.run(self)
return DecoratedCommand
def update_package_data(distribution):
"""update build_py options to get package_data changes"""
build_py = distribution.get_command_obj('build_py')
build_py.finalize_options()
class CoreDeps(Command):
description = 'ensure required core assets'
user_options = []
# Representative files that should exist after a successful core setup
targets = [
pjoin(here, 'jupyterlab', 'schemas', 'jupyter.extensions.shortcuts.json'),
pjoin(here, 'jupyterlab', 'themes', 'jupyterlab-theme-light-extension',
'images', 'jupyterlab.svg')
]
def initialize_options(self):
pass
def finalize_options(self):
pass
def run(self):
# Handle schemas.
schema = pjoin(here, 'jupyterlab', 'schemas')
if osp.exists(schema):
shutil.rmtree(schema)
os.makedirs(schema)
packages = glob.glob(pjoin(here, 'packages', '**', 'package.json'))
for pkg in packages:
with open(pkg) as fid:
data = json.load(fid)
if 'jupyterlab' not in data:
continue
schemaDir = data['jupyterlab'].get('schemaDir', '')
if schemaDir:
parentDir = osp.dirname(pkg)
files = glob.glob(pjoin(parentDir, schemaDir, '*.json'))
for file in files:
shutil.copy(file, schema)
# Handle themes
themes = pjoin(here, 'jupyterlab', 'themes')
if osp.exists(themes):
shutil.rmtree(themes)
os.makedirs(themes)
packages = glob.glob(pjoin(here, 'packages', '**', 'package.json'))
for pkg in packages:
with open(pkg) as fid:
data = json.load(fid)
if 'jupyterlab' not in data:
continue
themeDir = data['jupyterlab'].get('themeDir', '')
if themeDir:
name = data['name'].replace('@', '').replace('/', '-')
src = pjoin(osp.dirname(pkg), themeDir)
shutil.copytree(src, pjoin(themes, name))
# update package data in case this created new files
update_package_data(self.distribution)
class CheckAssets(Command):
description = 'check for required assets'
user_options = []
# Representative files that should exist after a successful build
targets = [
pjoin(here, 'jupyterlab', 'build', 'release_data.json'),
pjoin(here, 'jupyterlab', 'build', 'main.bundle.js'),
] + CoreDeps.targets
def initialize_options(self):
pass
def finalize_options(self):
pass
def run(self):
for t in self.targets:
if not osp.exists(t):
msg = 'Missing file: %s' % t
raise ValueError(msg)
target = pjoin(here, 'jupyterlab', 'build', 'release_data.json')
with open(target) as fid:
data = json.load(fid)
if (LooseVersion(data['version']) !=
LooseVersion(version_ns['__version__'])):
msg = 'Release assets version mismatch, please run npm publish'
raise ValueError(msg)
# update package data in case this created new files
update_package_data(self.distribution)
class bdist_egg_disabled(bdist_egg):
"""Disabled version of bdist_egg
Prevents setup.py install performing setuptools' default easy_install,
which it should never ever do.
"""
def run(self):
sys.exit("Aborting implicit building of eggs. Use `pip install .` to install from source.")