blob: c33d3c3b581247734666c3420d04561cb05ccedc [file] [log] [blame]
Fernando Perez36d3c162006-07-12 06:02:281#!/usr/bin/env python
Travis Oliphantc8b5a7e2006-01-06 02:12:502"""NumPy: array processing for numbers, strings, records, and objects.
Travis Oliphantda9c6da2006-01-04 17:31:073
Travis Oliphantc8b5a7e2006-01-06 02:12:504NumPy is a general-purpose array-processing package designed to
Travis Oliphantda9c6da2006-01-04 17:31:075efficiently manipulate large multi-dimensional arrays of arbitrary
6records without sacrificing too much speed for small multi-dimensional
Travis Oliphantc8b5a7e2006-01-06 02:12:507arrays. NumPy is built on the Numeric code base and adds features
Travis Oliphantda9c6da2006-01-04 17:31:078introduced by numarray as well as an extended C-API and the ability to
Travis Oliphant00a35872007-05-31 04:57:019create arrays of arbitrary type which also makes NumPy suitable for
10interfacing with general-purpose data-base applications.
Travis Oliphantda9c6da2006-01-04 17:31:0711
12There are also basic facilities for discrete fourier transform,
13basic linear algebra and random number generation.
Charles Harris6aa264c2013-02-27 20:26:5814
Matthew Brettbe575d52016-03-07 20:52:0815All numpy wheels distributed from pypi are BSD licensed.
16
17Windows wheels are linked against the ATLAS BLAS / LAPACK library, restricted
18to SSE2 instructions, so may not give optimal linear algebra performance for
19your machine. See http://docs.scipy.org/doc/numpy/user/install.html for
20alternatives.
21
Travis Oliphantda9c6da2006-01-04 17:31:0722"""
Charles Harrisbb726ca2013-04-06 19:25:2623from __future__ import division, print_function
Travis Oliphantda9c6da2006-01-04 17:31:0724
David Sanders922442f2015-10-19 20:03:3425DOCLINES = (__doc__ or '').split("\n")
Pearu Petersonc415fd12002-11-18 22:39:3126
Pearu Petersone8fa0132003-03-07 18:08:2827import os
28import sys
David Cournapeau5623a7c2009-04-02 16:21:3029import subprocess
Ralf Gommers99e99e92015-12-29 14:24:2230import textwrap
Pearu Petersonc415fd12002-11-18 22:39:3131
Ralf Gommers17716d72013-12-06 19:45:4032
Joseph Fox-Rabinovitz21d2fb72016-04-12 05:34:3933if sys.version_info[:2] < (2, 7) or (3, 0) <= sys.version_info[:2] < (3, 4):
Charles Harris3ce03de2016-04-09 15:18:2234 raise RuntimeError("Python version 2.7 or >= 3.4 required.")
Charles Harris28eadc02013-07-11 18:08:4935
Charles Harris09a52ed2013-03-28 23:13:5336if sys.version_info[0] >= 3:
David Cournapeau2b517692009-12-03 15:53:2937 import builtins
Charles Harris09a52ed2013-03-28 23:13:5338else:
39 import __builtin__ as builtins
David Cournapeau2b517692009-12-03 15:53:2940
Ralf Gommers17716d72013-12-06 19:45:4041
Travis Oliphantda9c6da2006-01-04 17:31:0742CLASSIFIERS = """\
Robert Kern19da9712008-06-18 22:53:4443Development Status :: 5 - Production/Stable
Travis Oliphantda9c6da2006-01-04 17:31:0744Intended Audience :: Science/Research
45Intended Audience :: Developers
46License :: OSI Approved
47Programming Language :: C
48Programming Language :: Python
Alex Willmer193668a2015-08-05 09:29:3949Programming Language :: Python :: 2
Alex Willmer193668a2015-08-05 09:29:3950Programming Language :: Python :: 2.7
rgommerscdac1202011-01-25 14:02:4051Programming Language :: Python :: 3
Alex Willmer193668a2015-08-05 09:29:3952Programming Language :: Python :: 3.4
53Programming Language :: Python :: 3.5
Charles Harrisb33a5ee2016-11-05 19:48:3054Programming Language :: Python :: 3.6
Alex Willmer193668a2015-08-05 09:29:3955Programming Language :: Python :: Implementation :: CPython
Travis Oliphantda9c6da2006-01-04 17:31:0756Topic :: Software Development
57Topic :: Scientific/Engineering
58Operating System :: Microsoft :: Windows
59Operating System :: POSIX
60Operating System :: Unix
61Operating System :: MacOS
62"""
63
Ralf Gommers58c1bf72012-11-05 19:47:2364MAJOR = 1
Charles Harrisa3afc252017-05-10 17:01:0865MINOR = 14
Allan Haldane29e17522018-04-28 17:47:2666MICRO = 4
Charles Harris83419d62018-06-06 14:43:0767ISRELEASED = True
Allan Haldaneb8df7052018-04-28 19:03:4068VERSION = '%d.%d.%d' % (MAJOR, MINOR, MICRO)
Stefan van der Waltb9a22d72009-06-17 14:28:0369
Ralf Gommers17716d72013-12-06 19:45:4070
Scott Sinclair58e63602010-11-09 15:09:1571# Return the git revision as a string
72def git_version():
David Cournapeau44d92ec2009-06-01 05:43:1673 def _minimal_ext_cmd(cmd):
74 # construct minimal environment
75 env = {}
Robert Kernc0be9952017-03-09 00:38:5476 for k in ['SYSTEMROOT', 'PATH', 'HOME']:
David Cournapeau5032b522009-09-18 10:10:3977 v = os.environ.get(k)
78 if v is not None:
79 env[k] = v
David Cournapeau44d92ec2009-06-01 05:43:1680 # LANGUAGE is used on win32
81 env['LANGUAGE'] = 'C'
82 env['LANG'] = 'C'
83 env['LC_ALL'] = 'C'
Charles Harris054d93a2017-11-29 18:53:2184 out = subprocess.Popen(cmd, stdout=subprocess.PIPE, env=env).communicate()[0]
David Cournapeau44d92ec2009-06-01 05:43:1685 return out
86
David Cournapeau5623a7c2009-04-02 16:21:3087 try:
Scott Sinclair58e63602010-11-09 15:09:1588 out = _minimal_ext_cmd(['git', 'rev-parse', 'HEAD'])
Pauli Virtanend1a184c2010-11-15 01:00:0689 GIT_REVISION = out.strip().decode('ascii')
David Cournapeau5623a7c2009-04-02 16:21:3090 except OSError:
Scott Sinclaird5ed7442010-11-10 05:19:1591 GIT_REVISION = "Unknown"
David Cournapeau5e041cb2009-03-27 11:16:0192
Scott Sinclair58e63602010-11-09 15:09:1593 return GIT_REVISION
David Cournapeau5e041cb2009-03-27 11:16:0194
Ralf Gommers4b0ed792015-12-29 10:29:3895# BEFORE importing setuptools, remove MANIFEST. Otherwise it may not be
96# properly updated when the contents of directories change (true for distutils,
97# not sure about setuptools).
98if os.path.exists('MANIFEST'):
99 os.remove('MANIFEST')
David Cournapeau5bb1aa52009-03-27 16:39:01100
101# This is a bit hackish: we are setting a global variable so that the main
102# numpy __init__ can detect if it is being loaded by the setup routine, to
103# avoid attempting to load components that aren't built yet. While ugly, it's
104# a lot more robust than what was previously being used.
David Cournapeau2b517692009-12-03 15:53:29105builtins.__NUMPY_SETUP__ = True
David Cournapeau5bb1aa52009-03-27 16:39:01106
rgommers13212a52011-03-03 16:13:08107
Ralf Gommers17716d72013-12-06 19:45:40108def get_version_info():
Ralf Gommers87e12c12011-03-24 15:30:06109 # Adding the git rev number needs to be done inside write_version_py(),
110 # otherwise the import of numpy.version messes up the build under Python 3.
111 FULLVERSION = VERSION
112 if os.path.exists('.git'):
113 GIT_REVISION = git_version()
114 elif os.path.exists('numpy/version.py'):
115 # must be a source distribution, use existing version file
Ralf Gommerscd6d53f2011-04-17 14:04:11116 try:
117 from numpy.version import git_revision as GIT_REVISION
118 except ImportError:
119 raise ImportError("Unable to import git_revision. Try removing " \
120 "numpy/version.py and the build directory " \
121 "before building.")
Ralf Gommers87e12c12011-03-24 15:30:06122 else:
123 GIT_REVISION = "Unknown"
124
125 if not ISRELEASED:
Ã…smund Hjulstade15f2922015-02-10 17:07:55126 FULLVERSION += '.dev0+' + GIT_REVISION[:7]
Ralf Gommers87e12c12011-03-24 15:30:06127
Ralf Gommers17716d72013-12-06 19:45:40128 return FULLVERSION, GIT_REVISION
129
130
131def write_version_py(filename='numpy/version.py'):
132 cnt = """
133# THIS FILE IS GENERATED FROM NUMPY SETUP.PY
Ralf Gommers105a4982015-12-29 20:58:36134#
135# To compare versions robustly, use `numpy.lib.NumpyVersion`
Ralf Gommers17716d72013-12-06 19:45:40136short_version = '%(version)s'
137version = '%(version)s'
138full_version = '%(full_version)s'
139git_revision = '%(git_revision)s'
140release = %(isrelease)s
141
142if not release:
143 version = full_version
144"""
145 FULLVERSION, GIT_REVISION = get_version_info()
146
David Cournapeaua2ac9852009-03-27 11:15:36147 a = open(filename, 'w')
148 try:
Scott Sinclair58e63602010-11-09 15:09:15149 a.write(cnt % {'version': VERSION,
Charles Harris054d93a2017-11-29 18:53:21150 'full_version': FULLVERSION,
151 'git_revision': GIT_REVISION,
Scott Sinclair58e63602010-11-09 15:09:15152 'isrelease': str(ISRELEASED)})
David Cournapeaua2ac9852009-03-27 11:15:36153 finally:
154 a.close()
155
Ralf Gommers17716d72013-12-06 19:45:40156
Pearu Peterson471196b2006-03-31 08:59:36157def configuration(parent_package='',top_path=None):
158 from numpy.distutils.misc_util import Configuration
159
Pearu Peterson17d7cfe2006-04-04 12:26:14160 config = Configuration(None, parent_package, top_path)
Pearu Peterson471196b2006-03-31 08:59:36161 config.set_options(ignore_setup_xxx_py=True,
162 assume_default_configuration=True,
163 delegate_options_to_subpackages=True,
164 quiet=True)
Jarrod Millman0b77f0e2007-10-29 14:58:18165
Pearu Peterson471196b2006-03-31 08:59:36166 config.add_subpackage('numpy')
Charles Harris054d93a2017-11-29 18:53:21167 config.add_data_files(('numpy', 'LICENSE.txt'))
Jarrod Millman0b77f0e2007-10-29 14:58:18168
Pearu Peterson17d7cfe2006-04-04 12:26:14169 config.get_version('numpy/version.py') # sets config.version
Travis Oliphant00a35872007-05-31 04:57:01170
Pearu Peterson471196b2006-03-31 08:59:36171 return config
172
Ralf Gommers4b0ed792015-12-29 10:29:38173
Julian Taylor4cd72742014-01-29 21:59:19174def check_submodules():
175 """ verify that the submodules are checked out and clean
176 use `git submodule update --init`; on failure
177 """
178 if not os.path.exists('.git'):
179 return
180 with open('.gitmodules') as f:
181 for l in f:
182 if 'path' in l:
183 p = l.split('=')[-1].strip()
184 if not os.path.exists(p):
185 raise ValueError('Submodule %s missing' % p)
186
187
188 proc = subprocess.Popen(['git', 'submodule', 'status'],
189 stdout=subprocess.PIPE)
190 status, _ = proc.communicate()
191 status = status.decode("ascii", "replace")
192 for line in status.splitlines():
193 if line.startswith('-') or line.startswith('+'):
194 raise ValueError('Submodule not clean: %s' % line)
195
Ralf Gommers4b0ed792015-12-29 10:29:38196
Ralf Gommers6770f982016-01-27 20:34:28197from distutils.command.sdist import sdist
Julian Taylor4cd72742014-01-29 21:59:19198class sdist_checked(sdist):
199 """ check submodules on sdist to prevent incomplete tarballs """
200 def run(self):
201 check_submodules()
202 sdist.run(self)
Travis Oliphant14db4192005-09-14 22:08:46203
Ralf Gommers4b0ed792015-12-29 10:29:38204
Julian Taylorc9fd6342014-04-05 11:13:13205def generate_cython():
206 cwd = os.path.abspath(os.path.dirname(__file__))
207 print("Cythonizing sources")
208 p = subprocess.call([sys.executable,
209 os.path.join(cwd, 'tools', 'cythonize.py'),
210 'numpy/random'],
211 cwd=cwd)
212 if p != 0:
213 raise RuntimeError("Running cythonize failed!")
214
Ralf Gommers4b0ed792015-12-29 10:29:38215
Ralf Gommersb9f48092015-12-29 11:05:30216def parse_setuppy_commands():
Ralf Gommers99e99e92015-12-29 14:24:22217 """Check the commands and respond appropriately. Disable broken commands.
218
219 Return a boolean value for whether or not to run the build or not (avoid
220 parsing Cython and template files if False).
221 """
Ralf Gommersb9f48092015-12-29 11:05:30222 if len(sys.argv) < 2:
223 # User forgot to give an argument probably, let setuptools handle that.
Ralf Gommers99e99e92015-12-29 14:24:22224 return True
Ralf Gommersb9f48092015-12-29 11:05:30225
Ralf Gommers99e99e92015-12-29 14:24:22226 info_commands = ['--help-commands', '--name', '--version', '-V',
227 '--fullname', '--author', '--author-email',
228 '--maintainer', '--maintainer-email', '--contact',
229 '--contact-email', '--url', '--license', '--description',
230 '--long-description', '--platforms', '--classifiers',
231 '--keywords', '--provides', '--requires', '--obsoletes']
232 # Add commands that do more than print info, but also don't need Cython and
233 # template parsing.
234 info_commands.extend(['egg_info', 'install_egg_info', 'rotate'])
235
236 for command in info_commands:
237 if command in sys.argv[1:]:
238 return False
239
240 # Note that 'alias', 'saveopts' and 'setopt' commands also seem to work
241 # fine as they are, but are usually used together with one of the commands
242 # below and not standalone. Hence they're not added to good_commands.
243 good_commands = ('develop', 'sdist', 'build', 'build_ext', 'build_py',
Ralf Gommersab5c6d02016-01-16 14:21:23244 'build_clib', 'build_scripts', 'bdist_wheel', 'bdist_rpm',
Ralf Gommersb9f48092015-12-29 11:05:30245 'bdist_wininst', 'bdist_msi', 'bdist_mpkg')
Ralf Gommers99e99e92015-12-29 14:24:22246
Ralf Gommersb9f48092015-12-29 11:05:30247 for command in good_commands:
248 if command in sys.argv[1:]:
Ralf Gommers99e99e92015-12-29 14:24:22249 return True
Ralf Gommersb9f48092015-12-29 11:05:30250
Ralf Gommersab5c6d02016-01-16 14:21:23251 # The following commands are supported, but we need to show more
Ralf Gommers99e99e92015-12-29 14:24:22252 # useful messages to the user
253 if 'install' in sys.argv[1:]:
254 print(textwrap.dedent("""
255 Note: if you need reliable uninstall behavior, then install
256 with pip instead of using `setup.py install`:
257
258 - `pip install .` (from a git repo or downloaded source
259 release)
Pierre de Buyl3f6672a2016-09-06 12:54:08260 - `pip install numpy` (last NumPy release on PyPi)
Ralf Gommers99e99e92015-12-29 14:24:22261
262 """))
263 return True
264
265 if '--help' in sys.argv[1:] or '-h' in sys.argv[1]:
266 print(textwrap.dedent("""
Pierre de Buyl3f6672a2016-09-06 12:54:08267 NumPy-specific help
Ralf Gommers99e99e92015-12-29 14:24:22268 -------------------
269
Pierre de Buyl3f6672a2016-09-06 12:54:08270 To install NumPy from here with reliable uninstall, we recommend
271 that you use `pip install .`. To install the latest NumPy release
Ralf Gommers99e99e92015-12-29 14:24:22272 from PyPi, use `pip install numpy`.
273
274 For help with build/installation issues, please ask on the
275 numpy-discussion mailing list. If you are sure that you have run
276 into a bug, please report it at https://github.com/numpy/numpy/issues.
277
278 Setuptools commands help
279 ------------------------
280 """))
281 return False
282
283 # The following commands aren't supported. They can only be executed when
284 # the user explicitly adds a --force command-line argument.
Ralf Gommersb9f48092015-12-29 11:05:30285 bad_commands = dict(
286 test="""
287 `setup.py test` is not supported. Use one of the following
288 instead:
289
290 - `python runtests.py` (to build and test)
291 - `python runtests.py --no-build` (to test installed numpy)
292 - `>>> numpy.test()` (run tests for installed numpy
293 from within an interpreter)
294 """,
295 upload="""
296 `setup.py upload` is not supported, because it's insecure.
297 Instead, build what you want to upload and upload those files
298 with `twine upload -s <filenames>` instead.
299 """,
300 upload_docs="`setup.py upload_docs` is not supported",
301 easy_install="`setup.py easy_install` is not supported",
302 clean="""
303 `setup.py clean` is not supported, use one of the following instead:
304
305 - `git clean -xdf` (cleans all files)
306 - `git clean -Xdf` (cleans all versioned files, doesn't touch
307 files that aren't checked into the git repo)
308 """,
309 check="`setup.py check` is not supported",
310 register="`setup.py register` is not supported",
311 bdist_dumb="`setup.py bdist_dumb` is not supported",
Ralf Gommers99e99e92015-12-29 14:24:22312 bdist="`setup.py bdist` is not supported",
313 build_sphinx="""
314 `setup.py build_sphinx` is not supported, use the
315 Makefile under doc/""",
316 flake8="`setup.py flake8` is not supported, use flake8 standalone",
Ralf Gommersb9f48092015-12-29 11:05:30317 )
Ralf Gommers99e99e92015-12-29 14:24:22318 bad_commands['nosetests'] = bad_commands['test']
Luca Mussi69d2cc82016-04-07 11:24:49319 for command in ('upload_docs', 'easy_install', 'bdist', 'bdist_dumb',
Ralf Gommers99e99e92015-12-29 14:24:22320 'register', 'check', 'install_data', 'install_headers',
321 'install_lib', 'install_scripts', ):
322 bad_commands[command] = "`setup.py %s` is not supported" % command
323
Ralf Gommersb9f48092015-12-29 11:05:30324 for command in bad_commands.keys():
325 if command in sys.argv[1:]:
Ralf Gommersb9f48092015-12-29 11:05:30326 print(textwrap.dedent(bad_commands[command]) +
327 "\nAdd `--force` to your command to use it anyway if you "
328 "must (unsupported).\n")
329 sys.exit(1)
330
Ralf Gommers99e99e92015-12-29 14:24:22331 # If we got here, we didn't detect what setup.py command was given
332 import warnings
333 warnings.warn("Unrecognized setuptools command, proceeding with "
Sebastian Berg7884a8c2016-01-23 14:58:58334 "generating Cython sources and expanding templates", stacklevel=2)
Ralf Gommers99e99e92015-12-29 14:24:22335 return True
Ralf Gommersb9f48092015-12-29 11:05:30336
337
Ralf Gommers17716d72013-12-06 19:45:40338def setup_package():
Charles Harrisb4180e32013-04-22 03:26:44339 src_path = os.path.dirname(os.path.abspath(sys.argv[0]))
Pauli Virtanen68159432009-12-06 11:56:18340 old_path = os.getcwd()
341 os.chdir(src_path)
342 sys.path.insert(0, src_path)
343
Pauli Virtanen01312182010-11-23 16:50:54344 # Rewrite the version file everytime
345 write_version_py()
346
Ralf Gommers17716d72013-12-06 19:45:40347 metadata = dict(
348 name = 'numpy',
349 maintainer = "NumPy Developers",
Ralf Gommers46f7dca2017-03-26 07:52:46350 maintainer_email = "numpy-discussion@python.org",
Ralf Gommers17716d72013-12-06 19:45:40351 description = DOCLINES[0],
352 long_description = "\n".join(DOCLINES[2:]),
353 url = "http://www.numpy.org",
354 author = "Travis E. Oliphant et al.",
Charles Harris8970ff22018-01-10 18:00:11355 download_url = "https://pypi.python.org/pypi/numpy",
Ralf Gommers17716d72013-12-06 19:45:40356 license = 'BSD',
357 classifiers=[_f for _f in CLASSIFIERS.split('\n') if _f],
358 platforms = ["Windows", "Linux", "Solaris", "Mac OS-X", "Unix"],
359 test_suite='nose.collector',
Julian Taylor4cd72742014-01-29 21:59:19360 cmdclass={"sdist": sdist_checked},
Ralf Gommers343de6f2017-04-15 21:29:55361 python_requires='>=2.7,!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*',
Ralf Gommers17716d72013-12-06 19:45:40362 )
363
Ralf Gommers99e99e92015-12-29 14:24:22364 if "--force" in sys.argv:
365 run_build = True
Ralf Gommers20c3c2a2017-06-20 10:09:40366 sys.argv.remove('--force')
Ralf Gommers99e99e92015-12-29 14:24:22367 else:
368 # Raise errors for unsupported commands, improve help output, etc.
369 run_build = parse_setuppy_commands()
Ralf Gommersb9f48092015-12-29 11:05:30370
371 from setuptools import setup
Ralf Gommers99e99e92015-12-29 14:24:22372 if run_build:
Ralf Gommers17716d72013-12-06 19:45:40373 from numpy.distutils.core import setup
Julian Taylorc9fd6342014-04-05 11:13:13374 cwd = os.path.abspath(os.path.dirname(__file__))
375 if not os.path.exists(os.path.join(cwd, 'PKG-INFO')):
376 # Generate Cython sources, unless building from source release
377 generate_cython()
Ralf Gommers4b0ed792015-12-29 10:29:38378
Ralf Gommers17716d72013-12-06 19:45:40379 metadata['configuration'] = configuration
Ralf Gommers99e99e92015-12-29 14:24:22380 else:
381 # Version number is added to metadata inside configuration() if build
382 # is run.
383 metadata['version'] = get_version_info()[0]
Pauli Virtanen68159432009-12-06 11:56:18384
Pearu Petersone8fa0132003-03-07 18:08:28385 try:
Ralf Gommers17716d72013-12-06 19:45:40386 setup(**metadata)
Pearu Petersone8fa0132003-03-07 18:08:28387 finally:
388 del sys.path[0]
389 os.chdir(old_path)
Travis Oliphant14db4192005-09-14 22:08:46390 return
Pearu Petersonc415fd12002-11-18 22:39:31391
Ralf Gommers17716d72013-12-06 19:45:40392
Travis Oliphant14db4192005-09-14 22:08:46393if __name__ == '__main__':
Pearu Petersone8fa0132003-03-07 18:08:28394 setup_package()
Ralf Gommersbbee7472016-08-21 05:23:35395 # This may avoid problems where numpy is installed via ``*_requires`` by
396 # setuptools, the global namespace isn't reset properly, and then numpy is
397 # imported later (which will then fail to load numpy extension modules).
398 # See gh-7956 for details
399 del builtins.__NUMPY_SETUP__