Switch branches/tags
Nothing to show
Find file
Fetching contributors…
Cannot retrieve contributors at this time
398 lines (328 sloc) 13.5 KB
# encoding: utf-8
This module defines the things that are used in for building IPython
This includes:
* The basic arguments to setup
* Functions for finding things like packages, package data, etc.
* A function for checking dependencies.
from __future__ import print_function
# Copyright (C) 2008 The IPython Development Team
# Distributed under the terms of the BSD License. The full license is in
# the file COPYING, distributed as part of this software.
# Imports
import os
import sys
from configparser import ConfigParser
from ConfigParser import ConfigParser
from distutils.command.build_py import build_py
from glob import glob
from setupext import install_data_ext
# Useful globals and utility functions
# A few handy globals
isfile = os.path.isfile
pjoin = os.path.join
def oscmd(s):
print(">", s)
# Py3 compatibility hacks, without assuming IPython itself is installed with
# the full py3compat machinery.
except NameError:
def execfile(fname, globs, locs=None):
locs = locs or globs
exec(compile(open(fname).read(), fname, "exec"), globs, locs)
# A little utility we'll need below, since glob() does NOT allow you to do
# exclusion on multiple endings!
def file_doesnt_endwith(test,endings):
"""Return true if test is a file and its name does NOT end with any
of the strings listed in endings."""
if not isfile(test):
return False
for e in endings:
if test.endswith(e):
return False
return True
# Basic project information
# contains version, authors, license, url, keywords, etc.
execfile(pjoin('IPython','core',''), globals())
# Create a dict with the basic information
# This dict is eventually passed to setup after additional keys are added.
setup_args = dict(
name = name,
version = version,
description = description,
long_description = long_description,
author = author,
author_email = author_email,
url = url,
download_url = download_url,
license = license,
platforms = platforms,
keywords = keywords,
classifiers = classifiers,
cmdclass = {'install_data': install_data_ext},
# Find packages
def find_packages():
Find all of IPython's packages.
excludes = ['deathrow', 'quarantine']
packages = []
for dir,subdirs,files in os.walk('IPython'):
package = dir.replace(os.path.sep, '.')
if any(package.startswith('IPython.'+exc) for exc in excludes):
# package is to be excluded (e.g. deathrow)
if '' not in files:
# not a package
return packages
# Find package data
def find_package_data():
Find IPython's package_data.
# This is not enough for these things to appear in an sdist.
# We need to muck with the MANIFEST to get this to work
# exclude static things that we don't ship (e.g. mathjax)
excludes = ['mathjax']
# add 'static/' prefix to exclusions, and tuplify for use in startswith
excludes = tuple([os.path.join('static', ex) for ex in excludes])
# walk notebook resources:
cwd = os.getcwd()
os.chdir(os.path.join('IPython', 'frontend', 'html', 'notebook'))
static_walk = list(os.walk('static'))
static_data = []
for parent, dirs, files in static_walk:
if parent.startswith(excludes):
for f in files:
static_data.append(os.path.join(parent, f))
package_data = {
'IPython.config.profile' : ['README*', '*/*.py'],
'IPython.testing' : ['*.txt'],
'IPython.testing.plugin' : ['*.txt'],
'IPython.frontend.html.notebook' : ['templates/*'] + static_data,
'IPython.frontend.qt.console' : ['resources/icon/*.svg'],
return package_data
# Find data files
def make_dir_struct(tag,base,out_base):
"""Make the directory structure of all files below a starting dir.
This is just a convenience routine to help build a nested directory
hierarchy because distutils is too stupid to do this by itself.
XXX - this needs a proper docstring!
# we'll use these a lot below
lbase = len(base)
pathsep = os.path.sep
lpathsep = len(pathsep)
out = []
for (dirpath,dirnames,filenames) in os.walk(base):
# we need to strip out the dirpath from the base to map it to the
# output (installation) path. This requires possibly stripping the
# path separator, because otherwise pjoin will not work correctly
# (pjoin('foo/','/bar') returns '/bar').
dp_eff = dirpath[lbase:]
if dp_eff.startswith(pathsep):
dp_eff = dp_eff[lpathsep:]
# The output path must be anchored at the out_base marker
out_path = pjoin(out_base,dp_eff)
# Now we can generate the final filenames. Since os.walk only produces
# filenames, we must join back with the dirpath to get full valid file
# paths:
pfiles = [pjoin(dirpath,f) for f in filenames]
# Finally, generate the entry we need, which is a pari of (output
# path, files) for use as a data_files parameter in install_data.
out.append((out_path, pfiles))
return out
def find_data_files():
Find IPython's data_files.
Most of these are docs.
docdirbase = pjoin('share', 'doc', 'ipython')
manpagebase = pjoin('share', 'man', 'man1')
# Simple file lists can be made by hand
manpages = filter(isfile, glob(pjoin('docs','man','*.1.gz')))
if not manpages:
# When running from a source tree, the manpages aren't gzipped
manpages = filter(isfile, glob(pjoin('docs','man','*.1')))
igridhelpfiles = filter(isfile,
# For nested structures, use the utility above
example_files = make_dir_struct(
manual_files = make_dir_struct(
# And assemble the entire output list
data_files = [ (manpagebase, manpages),
(pjoin(docdirbase, 'extensions'), igridhelpfiles),
] + manual_files + example_files
return data_files
def make_man_update_target(manpage):
"""Return a target_update-compliant tuple for the given manpage.
manpage : string
Name of the manpage, must include the section number (trailing number).
>>> make_man_update_target('ipython.1') #doctest: +NORMALIZE_WHITESPACE
'cd docs/man && gzip -9c ipython.1 > ipython.1.gz')
man_dir = pjoin('docs', 'man')
manpage_gz = manpage + '.gz'
manpath = pjoin(man_dir, manpage)
manpath_gz = pjoin(man_dir, manpage_gz)
gz_cmd = ( "cd %(man_dir)s && gzip -9c %(manpage)s > %(manpage_gz)s" %
locals() )
return (manpath_gz, [manpath], gz_cmd)
# The two functions below are copied from IPython.utils.path, so we don't need
# to import IPython during setup, which fails on Python 3.
def target_outdated(target,deps):
"""Determine whether a target is out of date.
target_outdated(target,deps) -> 1/0
deps: list of filenames which MUST exist.
target: single filename which may or may not exist.
If target doesn't exist or is older than any file listed in deps, return
true, otherwise return false.
target_time = os.path.getmtime(target)
except os.error:
return 1
for dep in deps:
dep_time = os.path.getmtime(dep)
if dep_time > target_time:
#print "For target",target,"Dep failed:",dep # dbg
#print "times (dep,tar):",dep_time,target_time # dbg
return 1
return 0
def target_update(target,deps,cmd):
"""Update a target with a given command given a list of dependencies.
target_update(target,deps,cmd) -> runs cmd if target is outdated.
This is just a wrapper around target_outdated() which calls the given
command if target is outdated."""
if target_outdated(target,deps):
# Find scripts
def find_scripts(entry_points=False, suffix=''):
"""Find IPython's scripts.
if entry_points is True:
return setuptools entry_point-style definitions
return file paths of plain scripts [default]
suffix is appended to script names if entry_points is True, so that the
Python 3 scripts get named "ipython3" etc.
if entry_points:
console_scripts = [s % suffix for s in [
'ipython%s = IPython.frontend.terminal.ipapp:launch_new_instance',
'pycolor%s = IPython.utils.PyColorize:main',
'ipcontroller%s = IPython.parallel.apps.ipcontrollerapp:launch_new_instance',
'ipengine%s = IPython.parallel.apps.ipengineapp:launch_new_instance',
'iplogger%s = IPython.parallel.apps.iploggerapp:launch_new_instance',
'ipcluster%s = IPython.parallel.apps.ipclusterapp:launch_new_instance',
'iptest%s = IPython.testing.iptest:main',
'irunner%s = IPython.lib.irunner:main'
gui_scripts = []
scripts = dict(console_scripts=console_scripts, gui_scripts=gui_scripts)
parallel_scripts = pjoin('IPython','parallel','scripts')
main_scripts = pjoin('IPython','scripts')
scripts = [
pjoin(parallel_scripts, 'ipengine'),
pjoin(parallel_scripts, 'ipcontroller'),
pjoin(parallel_scripts, 'ipcluster'),
pjoin(parallel_scripts, 'iplogger'),
pjoin(main_scripts, 'ipython'),
pjoin(main_scripts, 'pycolor'),
pjoin(main_scripts, 'irunner'),
pjoin(main_scripts, 'iptest')
return scripts
# Verify all dependencies
def check_for_dependencies():
"""Check for IPython's dependencies.
This function should NOT be called if running under setuptools!
from setupext.setupext import (
print_line, print_raw, print_status,
check_for_sphinx, check_for_pygments,
check_for_nose, check_for_pexpect,
check_for_pyzmq, check_for_readline
print_status('python', sys.version)
print_status('platform', sys.platform)
if sys.platform == 'win32':
print_status('Windows version', sys.getwindowsversion())
def record_commit_info(pkg_dir, build_cmd=build_py):
""" Return extended build command class for recording commit
records git commit in IPython.utils._sysinfo.commit
for use in IPython.utils.sysinfo.sys_info() calls after installation.
class MyBuildPy(build_cmd):
''' Subclass to write commit data into installation tree '''
def run(self):
import subprocess
proc = subprocess.Popen('git rev-parse --short HEAD',
repo_commit, _ = proc.communicate()
repo_commit = repo_commit.strip()
# We write the installation commit even if it's empty
out_pth = pjoin(self.build_lib, pkg_dir, 'utils', '')
with open(out_pth, 'w') as out_file:
'commit = "%s"\n' % repo_commit.decode('ascii'),
return MyBuildPy