# 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 pipes import sys from os.path import join as pjoin from distutils import log from distutils.cmd import Command 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 = os.path.dirname(os.path.abspath(__file__)) is_repo = os.path.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(os.path.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. """ return { 'jupyterlab': ['build/*', 'index.template.js', 'webpack.config.js', 'package.template.json', 'package_list.txt'] } 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(os.path.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 os.path.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 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'), ] def initialize_options(self): pass def finalize_options(self): pass def run(self): for t in self.targets: if not os.path.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 data['version'] != 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.")