Google Git
Sign in
chromium / external / github.com / numpy / numpy / refs/tags/v1.11.0 / . / setup.py
blob: cc8f3c18f26ae1cf3e94caca533bf142636509dc [file] [log] [blame]
Fernando Perez36d3c162006-07-12 06:02:28[diff] [blame]1#!/usr/bin/env python
Travis Oliphantc8b5a7e2006-01-06 02:12:50[diff] [blame]2"""NumPy: array processing for numbers, strings, records, and objects.
Travis Oliphantda9c6da2006-01-04 17:31:07[diff] [blame]3
Travis Oliphantc8b5a7e2006-01-06 02:12:50[diff] [blame]4NumPy is a general-purpose array-processing package designed to
Travis Oliphantda9c6da2006-01-04 17:31:07[diff] [blame]5efficiently manipulate large multi-dimensional arrays of arbitrary
6records without sacrificing too much speed for small multi-dimensional
Travis Oliphantc8b5a7e2006-01-06 02:12:50[diff] [blame]7arrays. NumPy is built on the Numeric code base and adds features
Travis Oliphantda9c6da2006-01-04 17:31:07[diff] [blame]8introduced by numarray as well as an extended C-API and the ability to
Travis Oliphant00a35872007-05-31 04:57:01[diff] [blame]9create arrays of arbitrary type which also makes NumPy suitable for
10interfacing with general-purpose data-base applications.
Travis Oliphantda9c6da2006-01-04 17:31:07[diff] [blame]11
12There are also basic facilities for discrete fourier transform,
13basic linear algebra and random number generation.
Charles Harris6aa264c2013-02-27 20:26:58[diff] [blame]14
Travis Oliphantda9c6da2006-01-04 17:31:07[diff] [blame]15"""
Charles Harrisbb726ca2013-04-06 19:25:26[diff] [blame]16from __future__ import division, print_function
Travis Oliphantda9c6da2006-01-04 17:31:07[diff] [blame]17
David Sanders922442f2015-10-19 20:03:34[diff] [blame]18DOCLINES = (__doc__ or '').split("\n")
Pearu Petersonc415fd12002-11-18 22:39:31[diff] [blame]19
Pearu Petersone8fa0132003-03-07 18:08:28[diff] [blame]20import os
21import sys
David Cournapeau5623a7c2009-04-02 16:21:30[diff] [blame]22import subprocess
Ralf Gommers99e99e92015-12-29 14:24:22[diff] [blame]23import textwrap
Pearu Petersonc415fd12002-11-18 22:39:31[diff] [blame]24
Ralf Gommers17716d72013-12-06 19:45:40[diff] [blame]25
Charles Harris28eadc02013-07-11 18:08:49[diff] [blame]26if sys.version_info[:2] < (2, 6) or (3, 0) <= sys.version_info[0:2] < (3, 2):
27 raise RuntimeError("Python version 2.6, 2.7 or >= 3.2 required.")
28
Charles Harris09a52ed2013-03-28 23:13:53[diff] [blame]29if sys.version_info[0] >= 3:
David Cournapeau2b517692009-12-03 15:53:29[diff] [blame]30 import builtins
Charles Harris09a52ed2013-03-28 23:13:53[diff] [blame]31else:
32 import __builtin__ as builtins
David Cournapeau2b517692009-12-03 15:53:29[diff] [blame]33
Ralf Gommers17716d72013-12-06 19:45:40[diff] [blame]34
Travis Oliphantda9c6da2006-01-04 17:31:07[diff] [blame]35CLASSIFIERS = """\
Robert Kern19da9712008-06-18 22:53:44[diff] [blame]36Development Status :: 5 - Production/Stable
Travis Oliphantda9c6da2006-01-04 17:31:07[diff] [blame]37Intended Audience :: Science/Research
38Intended Audience :: Developers
39License :: OSI Approved
40Programming Language :: C
41Programming Language :: Python
Alex Willmer193668a2015-08-05 09:29:39[diff] [blame]42Programming Language :: Python :: 2
43Programming Language :: Python :: 2.6
44Programming Language :: Python :: 2.7
rgommerscdac1202011-01-25 14:02:40[diff] [blame]45Programming Language :: Python :: 3
Alex Willmer193668a2015-08-05 09:29:39[diff] [blame]46Programming Language :: Python :: 3.2
47Programming Language :: Python :: 3.3
48Programming Language :: Python :: 3.4
49Programming Language :: Python :: 3.5
50Programming Language :: Python :: Implementation :: CPython
Travis Oliphantda9c6da2006-01-04 17:31:07[diff] [blame]51Topic :: Software Development
52Topic :: Scientific/Engineering
53Operating System :: Microsoft :: Windows
54Operating System :: POSIX
55Operating System :: Unix
56Operating System :: MacOS
57"""
58
Ralf Gommers58c1bf72012-11-05 19:47:23[diff] [blame]59MAJOR = 1
Charles Harrisb06dbc12015-08-03 01:55:14[diff] [blame]60MINOR = 11
David Cournapeau5e041cb2009-03-27 11:16:01[diff] [blame]61MICRO = 0
Charles Harris4092a9e2016-03-27 20:13:52[diff] [blame]62ISRELEASED = True
David Cournapeau5e041cb2009-03-27 11:16:01[diff] [blame]63VERSION = '%d.%d.%d' % (MAJOR, MINOR, MICRO)
Stefan van der Waltb9a22d72009-06-17 14:28:03[diff] [blame]64
Ralf Gommers17716d72013-12-06 19:45:40[diff] [blame]65
Scott Sinclair58e63602010-11-09 15:09:15[diff] [blame]66# Return the git revision as a string
67def git_version():
David Cournapeau44d92ec2009-06-01 05:43:16[diff] [blame]68 def _minimal_ext_cmd(cmd):
69 # construct minimal environment
70 env = {}
David Cournapeau5032b522009-09-18 10:10:39[diff] [blame]71 for k in ['SYSTEMROOT', 'PATH']:
72 v = os.environ.get(k)
73 if v is not None:
74 env[k] = v
David Cournapeau44d92ec2009-06-01 05:43:16[diff] [blame]75 # LANGUAGE is used on win32
76 env['LANGUAGE'] = 'C'
77 env['LANG'] = 'C'
78 env['LC_ALL'] = 'C'
79 out = subprocess.Popen(cmd, stdout = subprocess.PIPE, env=env).communicate()[0]
80 return out
81
David Cournapeau5623a7c2009-04-02 16:21:30[diff] [blame]82 try:
Scott Sinclair58e63602010-11-09 15:09:15[diff] [blame]83 out = _minimal_ext_cmd(['git', 'rev-parse', 'HEAD'])
Pauli Virtanend1a184c2010-11-15 01:00:06[diff] [blame]84 GIT_REVISION = out.strip().decode('ascii')
David Cournapeau5623a7c2009-04-02 16:21:30[diff] [blame]85 except OSError:
Scott Sinclaird5ed7442010-11-10 05:19:15[diff] [blame]86 GIT_REVISION = "Unknown"
David Cournapeau5e041cb2009-03-27 11:16:01[diff] [blame]87
Scott Sinclair58e63602010-11-09 15:09:15[diff] [blame]88 return GIT_REVISION
David Cournapeau5e041cb2009-03-27 11:16:01[diff] [blame]89
Ralf Gommers4b0ed792015-12-29 10:29:38[diff] [blame]90# BEFORE importing setuptools, remove MANIFEST. Otherwise it may not be
91# properly updated when the contents of directories change (true for distutils,
92# not sure about setuptools).
93if os.path.exists('MANIFEST'):
94 os.remove('MANIFEST')
David Cournapeau5bb1aa52009-03-27 16:39:01[diff] [blame]95
96# This is a bit hackish: we are setting a global variable so that the main
97# numpy __init__ can detect if it is being loaded by the setup routine, to
98# avoid attempting to load components that aren't built yet. While ugly, it's
99# a lot more robust than what was previously being used.
David Cournapeau2b517692009-12-03 15:53:29[diff] [blame]100builtins.__NUMPY_SETUP__ = True
David Cournapeau5bb1aa52009-03-27 16:39:01[diff] [blame]101
rgommers13212a52011-03-03 16:13:08[diff] [blame]102
Ralf Gommers17716d72013-12-06 19:45:40[diff] [blame]103def get_version_info():
Ralf Gommers87e12c12011-03-24 15:30:06[diff] [blame]104 # Adding the git rev number needs to be done inside write_version_py(),
105 # otherwise the import of numpy.version messes up the build under Python 3.
106 FULLVERSION = VERSION
107 if os.path.exists('.git'):
108 GIT_REVISION = git_version()
109 elif os.path.exists('numpy/version.py'):
110 # must be a source distribution, use existing version file
Ralf Gommerscd6d53f2011-04-17 14:04:11[diff] [blame]111 try:
112 from numpy.version import git_revision as GIT_REVISION
113 except ImportError:
114 raise ImportError("Unable to import git_revision. Try removing " \
115 "numpy/version.py and the build directory " \
116 "before building.")
Ralf Gommers87e12c12011-03-24 15:30:06[diff] [blame]117 else:
118 GIT_REVISION = "Unknown"
119
120 if not ISRELEASED:
Åsmund Hjulstade15f2922015-02-10 17:07:55[diff] [blame]121 FULLVERSION += '.dev0+' + GIT_REVISION[:7]
Ralf Gommers87e12c12011-03-24 15:30:06[diff] [blame]122
Ralf Gommers17716d72013-12-06 19:45:40[diff] [blame]123 return FULLVERSION, GIT_REVISION
124
125
126def write_version_py(filename='numpy/version.py'):
127 cnt = """
128# THIS FILE IS GENERATED FROM NUMPY SETUP.PY
Ralf Gommers105a4982015-12-29 20:58:36[diff] [blame]129#
130# To compare versions robustly, use `numpy.lib.NumpyVersion`
Ralf Gommers17716d72013-12-06 19:45:40[diff] [blame]131short_version = '%(version)s'
132version = '%(version)s'
133full_version = '%(full_version)s'
134git_revision = '%(git_revision)s'
135release = %(isrelease)s
136
137if not release:
138 version = full_version
139"""
140 FULLVERSION, GIT_REVISION = get_version_info()
141
David Cournapeaua2ac9852009-03-27 11:15:36[diff] [blame]142 a = open(filename, 'w')
143 try:
Scott Sinclair58e63602010-11-09 15:09:15[diff] [blame]144 a.write(cnt % {'version': VERSION,
rgommers13212a52011-03-03 16:13:08[diff] [blame]145 'full_version' : FULLVERSION,
Scott Sinclair58e63602010-11-09 15:09:15[diff] [blame]146 'git_revision' : GIT_REVISION,
147 'isrelease': str(ISRELEASED)})
David Cournapeaua2ac9852009-03-27 11:15:36[diff] [blame]148 finally:
149 a.close()
150
Ralf Gommers17716d72013-12-06 19:45:40[diff] [blame]151
Pearu Peterson471196b2006-03-31 08:59:36[diff] [blame]152def configuration(parent_package='',top_path=None):
153 from numpy.distutils.misc_util import Configuration
154
Pearu Peterson17d7cfe2006-04-04 12:26:14[diff] [blame]155 config = Configuration(None, parent_package, top_path)
Pearu Peterson471196b2006-03-31 08:59:36[diff] [blame]156 config.set_options(ignore_setup_xxx_py=True,
157 assume_default_configuration=True,
158 delegate_options_to_subpackages=True,
159 quiet=True)
Jarrod Millman0b77f0e2007-10-29 14:58:18[diff] [blame]160
Pearu Peterson471196b2006-03-31 08:59:36[diff] [blame]161 config.add_subpackage('numpy')
Jarrod Millman0b77f0e2007-10-29 14:58:18[diff] [blame]162
Pearu Peterson17d7cfe2006-04-04 12:26:14[diff] [blame]163 config.get_version('numpy/version.py') # sets config.version
Travis Oliphant00a35872007-05-31 04:57:01[diff] [blame]164
Pearu Peterson471196b2006-03-31 08:59:36[diff] [blame]165 return config
166
Ralf Gommers4b0ed792015-12-29 10:29:38[diff] [blame]167
Julian Taylor4cd72742014-01-29 21:59:19[diff] [blame]168def check_submodules():
169 """ verify that the submodules are checked out and clean
170 use `git submodule update --init`; on failure
171 """
172 if not os.path.exists('.git'):
173 return
174 with open('.gitmodules') as f:
175 for l in f:
176 if 'path' in l:
177 p = l.split('=')[-1].strip()
178 if not os.path.exists(p):
179 raise ValueError('Submodule %s missing' % p)
180
181
182 proc = subprocess.Popen(['git', 'submodule', 'status'],
183 stdout=subprocess.PIPE)
184 status, _ = proc.communicate()
185 status = status.decode("ascii", "replace")
186 for line in status.splitlines():
187 if line.startswith('-') or line.startswith('+'):
188 raise ValueError('Submodule not clean: %s' % line)
189
Ralf Gommers4b0ed792015-12-29 10:29:38[diff] [blame]190
Ralf Gommers7f5efd12016-01-27 20:34:28[diff] [blame]191from distutils.command.sdist import sdist
Julian Taylor4cd72742014-01-29 21:59:19[diff] [blame]192class sdist_checked(sdist):
193 """ check submodules on sdist to prevent incomplete tarballs """
194 def run(self):
195 check_submodules()
196 sdist.run(self)
Travis Oliphant14db4192005-09-14 22:08:46[diff] [blame]197
Ralf Gommers4b0ed792015-12-29 10:29:38[diff] [blame]198
Julian Taylorc9fd6342014-04-05 11:13:13[diff] [blame]199def generate_cython():
200 cwd = os.path.abspath(os.path.dirname(__file__))
201 print("Cythonizing sources")
202 p = subprocess.call([sys.executable,
203 os.path.join(cwd, 'tools', 'cythonize.py'),
204 'numpy/random'],
205 cwd=cwd)
206 if p != 0:
207 raise RuntimeError("Running cythonize failed!")
208
Ralf Gommers4b0ed792015-12-29 10:29:38[diff] [blame]209
Ralf Gommersb9f48092015-12-29 11:05:30[diff] [blame]210def parse_setuppy_commands():
Ralf Gommers99e99e92015-12-29 14:24:22[diff] [blame]211 """Check the commands and respond appropriately. Disable broken commands.
212
213 Return a boolean value for whether or not to run the build or not (avoid
214 parsing Cython and template files if False).
215 """
Ralf Gommersb9f48092015-12-29 11:05:30[diff] [blame]216 if len(sys.argv) < 2:
217 # User forgot to give an argument probably, let setuptools handle that.
Ralf Gommers99e99e92015-12-29 14:24:22[diff] [blame]218 return True
Ralf Gommersb9f48092015-12-29 11:05:30[diff] [blame]219
Ralf Gommers99e99e92015-12-29 14:24:22[diff] [blame]220 info_commands = ['--help-commands', '--name', '--version', '-V',
221 '--fullname', '--author', '--author-email',
222 '--maintainer', '--maintainer-email', '--contact',
223 '--contact-email', '--url', '--license', '--description',
224 '--long-description', '--platforms', '--classifiers',
225 '--keywords', '--provides', '--requires', '--obsoletes']
226 # Add commands that do more than print info, but also don't need Cython and
227 # template parsing.
228 info_commands.extend(['egg_info', 'install_egg_info', 'rotate'])
229
230 for command in info_commands:
231 if command in sys.argv[1:]:
232 return False
233
234 # Note that 'alias', 'saveopts' and 'setopt' commands also seem to work
235 # fine as they are, but are usually used together with one of the commands
236 # below and not standalone. Hence they're not added to good_commands.
237 good_commands = ('develop', 'sdist', 'build', 'build_ext', 'build_py',
Ralf Gommersab5c6d02016-01-16 14:21:23[diff] [blame]238 'build_clib', 'build_scripts', 'bdist_wheel', 'bdist_rpm',
Ralf Gommersb9f48092015-12-29 11:05:30[diff] [blame]239 'bdist_wininst', 'bdist_msi', 'bdist_mpkg')
Ralf Gommers99e99e92015-12-29 14:24:22[diff] [blame]240
Ralf Gommersb9f48092015-12-29 11:05:30[diff] [blame]241 for command in good_commands:
242 if command in sys.argv[1:]:
Ralf Gommers99e99e92015-12-29 14:24:22[diff] [blame]243 return True
Ralf Gommersb9f48092015-12-29 11:05:30[diff] [blame]244
Ralf Gommersab5c6d02016-01-16 14:21:23[diff] [blame]245 # The following commands are supported, but we need to show more
Ralf Gommers99e99e92015-12-29 14:24:22[diff] [blame]246 # useful messages to the user
247 if 'install' in sys.argv[1:]:
248 print(textwrap.dedent("""
249 Note: if you need reliable uninstall behavior, then install
250 with pip instead of using `setup.py install`:
251
252 - `pip install .` (from a git repo or downloaded source
253 release)
254 - `pip install numpy` (last Numpy release on PyPi)
255
256 """))
257 return True
258
259 if '--help' in sys.argv[1:] or '-h' in sys.argv[1]:
260 print(textwrap.dedent("""
261 Numpy-specific help
262 -------------------
263
264 To install Numpy from here with reliable uninstall, we recommend
265 that you use `pip install .`. To install the latest Numpy release
266 from PyPi, use `pip install numpy`.
267
268 For help with build/installation issues, please ask on the
269 numpy-discussion mailing list. If you are sure that you have run
270 into a bug, please report it at https://github.com/numpy/numpy/issues.
271
272 Setuptools commands help
273 ------------------------
274 """))
275 return False
276
277 # The following commands aren't supported. They can only be executed when
278 # the user explicitly adds a --force command-line argument.
Ralf Gommersb9f48092015-12-29 11:05:30[diff] [blame]279 bad_commands = dict(
280 test="""
281 `setup.py test` is not supported. Use one of the following
282 instead:
283
284 - `python runtests.py` (to build and test)
285 - `python runtests.py --no-build` (to test installed numpy)
286 - `>>> numpy.test()` (run tests for installed numpy
287 from within an interpreter)
288 """,
289 upload="""
290 `setup.py upload` is not supported, because it's insecure.
291 Instead, build what you want to upload and upload those files
292 with `twine upload -s <filenames>` instead.
293 """,
294 upload_docs="`setup.py upload_docs` is not supported",
295 easy_install="`setup.py easy_install` is not supported",
296 clean="""
297 `setup.py clean` is not supported, use one of the following instead:
298
299 - `git clean -xdf` (cleans all files)
300 - `git clean -Xdf` (cleans all versioned files, doesn't touch
301 files that aren't checked into the git repo)
302 """,
303 check="`setup.py check` is not supported",
304 register="`setup.py register` is not supported",
305 bdist_dumb="`setup.py bdist_dumb` is not supported",
Ralf Gommers99e99e92015-12-29 14:24:22[diff] [blame]306 bdist="`setup.py bdist` is not supported",
307 build_sphinx="""
308 `setup.py build_sphinx` is not supported, use the
309 Makefile under doc/""",
310 flake8="`setup.py flake8` is not supported, use flake8 standalone",
Ralf Gommersb9f48092015-12-29 11:05:30[diff] [blame]311 )
Ralf Gommers99e99e92015-12-29 14:24:22[diff] [blame]312 bad_commands['nosetests'] = bad_commands['test']
313 for commands in ('upload_docs', 'easy_install', 'bdist', 'bdist_dumb',
314 'register', 'check', 'install_data', 'install_headers',
315 'install_lib', 'install_scripts', ):
316 bad_commands[command] = "`setup.py %s` is not supported" % command
317
Ralf Gommersb9f48092015-12-29 11:05:30[diff] [blame]318 for command in bad_commands.keys():
319 if command in sys.argv[1:]:
Ralf Gommersb9f48092015-12-29 11:05:30[diff] [blame]320 print(textwrap.dedent(bad_commands[command]) +
321 "\nAdd `--force` to your command to use it anyway if you "
322 "must (unsupported).\n")
323 sys.exit(1)
324
Ralf Gommers99e99e92015-12-29 14:24:22[diff] [blame]325 # If we got here, we didn't detect what setup.py command was given
326 import warnings
327 warnings.warn("Unrecognized setuptools command, proceeding with "
328 "generating Cython sources and expanding templates")
329 return True
Ralf Gommersb9f48092015-12-29 11:05:30[diff] [blame]330
331
Ralf Gommers17716d72013-12-06 19:45:40[diff] [blame]332def setup_package():
Charles Harrisb4180e32013-04-22 03:26:44[diff] [blame]333 src_path = os.path.dirname(os.path.abspath(sys.argv[0]))
Pauli Virtanen68159432009-12-06 11:56:18[diff] [blame]334 old_path = os.getcwd()
335 os.chdir(src_path)
336 sys.path.insert(0, src_path)
337
Pauli Virtanen01312182010-11-23 16:50:54[diff] [blame]338 # Rewrite the version file everytime
339 write_version_py()
340
Ralf Gommers17716d72013-12-06 19:45:40[diff] [blame]341 metadata = dict(
342 name = 'numpy',
343 maintainer = "NumPy Developers",
344 maintainer_email = "numpy-discussion@scipy.org",
345 description = DOCLINES[0],
346 long_description = "\n".join(DOCLINES[2:]),
347 url = "http://www.numpy.org",
348 author = "Travis E. Oliphant et al.",
349 download_url = "http://sourceforge.net/projects/numpy/files/NumPy/",
350 license = 'BSD',
351 classifiers=[_f for _f in CLASSIFIERS.split('\n') if _f],
352 platforms = ["Windows", "Linux", "Solaris", "Mac OS-X", "Unix"],
353 test_suite='nose.collector',
Julian Taylor4cd72742014-01-29 21:59:19[diff] [blame]354 cmdclass={"sdist": sdist_checked},
Ralf Gommers17716d72013-12-06 19:45:40[diff] [blame]355 )
356
Ralf Gommers99e99e92015-12-29 14:24:22[diff] [blame]357 if "--force" in sys.argv:
358 run_build = True
359 else:
360 # Raise errors for unsupported commands, improve help output, etc.
361 run_build = parse_setuppy_commands()
Ralf Gommersb9f48092015-12-29 11:05:30[diff] [blame]362
363 from setuptools import setup
Ralf Gommers99e99e92015-12-29 14:24:22[diff] [blame]364 if run_build:
Ralf Gommers17716d72013-12-06 19:45:40[diff] [blame]365 from numpy.distutils.core import setup
Julian Taylorc9fd6342014-04-05 11:13:13[diff] [blame]366 cwd = os.path.abspath(os.path.dirname(__file__))
367 if not os.path.exists(os.path.join(cwd, 'PKG-INFO')):
368 # Generate Cython sources, unless building from source release
369 generate_cython()
Ralf Gommers4b0ed792015-12-29 10:29:38[diff] [blame]370
Ralf Gommers17716d72013-12-06 19:45:40[diff] [blame]371 metadata['configuration'] = configuration
Ralf Gommers99e99e92015-12-29 14:24:22[diff] [blame]372 else:
373 # Version number is added to metadata inside configuration() if build
374 # is run.
375 metadata['version'] = get_version_info()[0]
Pauli Virtanen68159432009-12-06 11:56:18[diff] [blame]376
Pearu Petersone8fa0132003-03-07 18:08:28[diff] [blame]377 try:
Ralf Gommers17716d72013-12-06 19:45:40[diff] [blame]378 setup(**metadata)
Pearu Petersone8fa0132003-03-07 18:08:28[diff] [blame]379 finally:
380 del sys.path[0]
381 os.chdir(old_path)
Travis Oliphant14db4192005-09-14 22:08:46[diff] [blame]382 return
Pearu Petersonc415fd12002-11-18 22:39:31[diff] [blame]383
Ralf Gommers17716d72013-12-06 19:45:40[diff] [blame]384
Travis Oliphant14db4192005-09-14 22:08:46[diff] [blame]385if __name__ == '__main__':
Pearu Petersone8fa0132003-03-07 18:08:28[diff] [blame]386 setup_package()