mirror/notebook
2
0
Fork 0
mirror of https://github.com/jupyter/notebook.git synced 2025-04-06 13:50:29 +08:00
Code Issues Packages Projects Releases Wiki Activity

Merge branch 'version-info' into trunk

Browse Source
This commit is contained in:
Fernando Perez 2010-10-29 20:29:16 -07:00
commit 0d8b493329
4 changed files with 95 additions and 26 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
.gitignore vendored
View File

@ -1,8 +1,10 @@
build
./dist
docs/dist
docs/build/*
docs/source/api/generated
*.pyc
*.py[co]
build
*.egg-info
*.py~
*~
*.bak

2
IPython/testing/iptest.py
View File

@ -115,7 +115,7 @@ have['gobject'] = test_for('gobject')
def report():
"""Return a string with a summary report of test-related variables."""
out = [ sys_info() ]
out = [ sys_info(), '\n']
avail = []
not_avail = []

18
setup.py
View File

@ -6,12 +6,16 @@ Under Posix environments it works like a typical setup.py script.
Under Windows, the command sdist is not supported, since IPython
requires utilities which are not available under Windows."""
#-------------------------------------------------------------------------------
# Copyright (C) 2008 The IPython Development Team
#-----------------------------------------------------------------------------
# Copyright (c) 2008-2010, IPython Development Team.
# Copyright (c) 2001-2007, Fernando Perez <fernando.perez@colorado.edu>
# Copyright (c) 2001, Janko Hauser <jhauser@zscout.de>
# Copyright (c) 2001, Nathaniel Gray <n8gray@caltech.edu>
#
# Distributed under the terms of the BSD License. The full license is in
# the file COPYING, distributed as part of this software.
#-------------------------------------------------------------------------------
# Distributed under the terms of the Modified BSD License.
#
# The full license is in the file COPYING.txt, distributed with this software.
#-----------------------------------------------------------------------------
#-----------------------------------------------------------------------------
# Minimal Python version sanity check
@ -55,7 +59,8 @@ from setupbase import (
find_package_data,
find_scripts,
find_data_files,
check_for_dependencies
check_for_dependencies,
record_commit_info,
)
isfile = os.path.isfile
@ -239,6 +244,7 @@ else:
# Do the actual setup now
#---------------------------------------------------------------------------
setup_args['cmdclass'] = {'build_py': record_commit_info('IPython')}
setup_args['packages'] = packages
setup_args['package_data'] = package_data
setup_args['scripts'] = scripts

95
setupbase.py
View File

@ -1,5 +1,4 @@
# encoding: utf-8
"""
This module defines the things that are used in setup.py for building IPython
@ -9,8 +8,7 @@ This includes:
* Functions for finding things like packages, package data, etc.
* A function for checking dependencies.
"""
__docformat__ = "restructuredtext en"
from __future__ import print_function
#-------------------------------------------------------------------------------
# Copyright (C) 2008 The IPython Development Team
@ -22,9 +20,11 @@ __docformat__ = "restructuredtext en"
#-------------------------------------------------------------------------------
# Imports
#-------------------------------------------------------------------------------
import os
import sys
import os, sys
from ConfigParser import ConfigParser
from distutils.command.build_py import build_py
from glob import glob
from setupext import install_data_ext
@ -38,7 +38,7 @@ isfile = os.path.isfile
pjoin = os.path.join
def oscmd(s):
print ">", s
print(">", s)
os.system(s)
# A little utility we'll need below, since glob() does NOT allow you to do
@ -175,9 +175,9 @@ def make_dir_struct(tag,base,out_base):
# 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 triple of (tag,output
# 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((tag,out_path,pfiles))
out.append((out_path, pfiles))
return out
@ -194,7 +194,8 @@ def find_data_files():
# Simple file lists can be made by hand
manpages = filter(isfile, glob(pjoin('docs','man','*.1.gz')))
igridhelpfiles = filter(isfile, glob(pjoin('IPython','extensions','igrid_help.*')))
igridhelpfiles = filter(isfile,
glob(pjoin('IPython','extensions','igrid_help.*')))
# For nested structures, use the utility above
example_files = make_dir_struct(
@ -209,15 +210,15 @@ def find_data_files():
)
# And assemble the entire output list
data_files = [ ('data',manpagebase, manpages),
('data',pjoin(docdirbase,'extensions'),igridhelpfiles),
data_files = [ (manpagebase, manpages),
(pjoin(docdirbase, 'extensions'), igridhelpfiles),
] + manual_files + example_files
## import pprint # dbg
## print '*'*80
## print 'data files'
## print('*'*80)
## print('data files')
## pprint.pprint(data_files)
## print '*'*80
## print('*'*80)
return data_files
@ -271,8 +272,10 @@ def find_scripts():
# post-install scripts MUST reside in the scripts/ dir, otherwise distutils
# doesn't find them.
if 'bdist_wininst' in sys.argv:
if len(sys.argv) > 2 and ('sdist' in sys.argv or 'bdist_rpm' in sys.argv):
print >> sys.stderr,"ERROR: bdist_wininst must be run alone. Exiting."
if len(sys.argv) > 2 and \
('sdist' in sys.argv or 'bdist_rpm' in sys.argv):
print("ERROR: bdist_wininst must be run alone. Exiting.",
file=sys.stderr)
sys.exit(1)
scripts.append(pjoin('scripts','ipython_win_post_install.py'))
@ -288,7 +291,7 @@ def check_for_dependencies():
This function should NOT be called if running under setuptools!
"""
from setupext.setupext import (
print_line, print_raw, print_status, print_message,
print_line, print_raw, print_status,
check_for_zopeinterface, check_for_twisted,
check_for_foolscap, check_for_pyopenssl,
check_for_sphinx, check_for_pygments,
@ -312,3 +315,61 @@ def check_for_dependencies():
check_for_pygments()
check_for_nose()
check_for_pexpect()
def record_commit_info(pkg_dir, build_cmd=build_py):
""" Return extended build command class for recording commit
The extended command tries to run git to find the current commit, getting
the empty string if it fails. It then writes the commit hash into a file
in the `pkg_dir` path, named ``.git_commit_info.ini``.
In due course this information can be used by the package after it is
installed, to tell you what commit it was installed from if known.
To make use of this system, you need a package with a .git_commit_info.ini
file - e.g. ``myproject/.git_commit_info.ini`` - that might well look like
this::
# This is an ini file that may contain information about the code state
[commit hash]
# The line below may contain a valid hash if it has been substituted
# during 'git archive'
archive_subst_hash=$Format:%h$
# This line may be modified by the install process
install_hash=
The .git_commit_info file above is also designed to be used with git
substitution - so you probably also want a ``.gitattributes`` file in the
root directory of your working tree that contains something like this::
myproject/.git_commit_info.ini export-subst
That will cause the ``.git_commit_info.ini`` file to get filled in by ``git
archive`` - useful in case someone makes such an archive - for example with
via the github 'download source' button.
Although all the above will work as is, you might consider having something
like a ``get_info()`` function in your package to display the commit
information at the terminal. See the ``pkg_info.py`` module in the nipy
package for an example.
"""
class MyBuildPy(build_cmd):
''' Subclass to write commit data into installation tree '''
def run(self):
build_py.run(self)
import subprocess
proc = subprocess.Popen('git rev-parse --short HEAD',
stdout=subprocess.PIPE,
stderr=subprocess.PIPE,
shell=True)
repo_commit, _ = proc.communicate()
# We write the installation commit even if it's empty
cfg_parser = ConfigParser()
cfg_parser.read(pjoin(pkg_dir, '.git_commit_info.ini'))
cfg_parser.set('commit hash', 'install_hash', repo_commit)
out_pth = pjoin(self.build_lib, pkg_dir, '.git_commit_info.ini')
out_file = open(out_pth, 'wt')
cfg_parser.write(out_file)
out_file.close()
return MyBuildPy