Fernando Perez | 36d3c16 | 2006-07-12 06:02:28 | [diff] [blame] | 1 | #!/usr/bin/env python |
Ralf Gommers | 759dd95 | 2018-08-23 17:11:58 | [diff] [blame] | 2 | """ NumPy is the fundamental package for array computing with Python. |
Travis Oliphant | da9c6da | 2006-01-04 17:31:07 | [diff] [blame] | 3 | |
Ralf Gommers | 759dd95 | 2018-08-23 17:11:58 | [diff] [blame] | 4 | It provides: |
Travis Oliphant | da9c6da | 2006-01-04 17:31:07 | [diff] [blame] | 5 | |
Ralf Gommers | 759dd95 | 2018-08-23 17:11:58 | [diff] [blame] | 6 | - a powerful N-dimensional array object |
| 7 | - sophisticated (broadcasting) functions |
| 8 | - tools for integrating C/C++ and Fortran code |
| 9 | - useful linear algebra, Fourier transform, and random number capabilities |
| 10 | - and much more |
Charles Harris | 6aa264c | 2013-02-27 20:26:58 | [diff] [blame] | 11 | |
Ralf Gommers | 759dd95 | 2018-08-23 17:11:58 | [diff] [blame] | 12 | Besides its obvious scientific uses, NumPy can also be used as an efficient |
| 13 | multi-dimensional container of generic data. Arbitrary data-types can be |
| 14 | defined. This allows NumPy to seamlessly and speedily integrate with a wide |
| 15 | variety of databases. |
Matthew Brett | be575d5 | 2016-03-07 20:52:08 | [diff] [blame] | 16 | |
Ralf Gommers | 759dd95 | 2018-08-23 17:11:58 | [diff] [blame] | 17 | All NumPy wheels distributed on PyPI are BSD licensed. |
Matthew Brett | be575d5 | 2016-03-07 20:52:08 | [diff] [blame] | 18 | |
Travis Oliphant | da9c6da | 2006-01-04 17:31:07 | [diff] [blame] | 19 | """ |
Charles Harris | bb726ca | 2013-04-06 19:25:26 | [diff] [blame] | 20 | from __future__ import division, print_function |
Travis Oliphant | da9c6da | 2006-01-04 17:31:07 | [diff] [blame] | 21 | |
David Sanders | 922442f | 2015-10-19 20:03:34 | [diff] [blame] | 22 | DOCLINES = (__doc__ or '').split("\n") |
Pearu Peterson | c415fd1 | 2002-11-18 22:39:31 | [diff] [blame] | 23 | |
Pearu Peterson | e8fa013 | 2003-03-07 18:08:28 | [diff] [blame] | 24 | import os |
| 25 | import sys |
David Cournapeau | 5623a7c | 2009-04-02 16:21:30 | [diff] [blame] | 26 | import subprocess |
Ralf Gommers | 99e99e9 | 2015-12-29 14:24:22 | [diff] [blame] | 27 | import textwrap |
Pearu Peterson | c415fd1 | 2002-11-18 22:39:31 | [diff] [blame] | 28 | |
Ralf Gommers | 17716d7 | 2013-12-06 19:45:40 | [diff] [blame] | 29 | |
Charles Harris | badf290 | 2018-12-07 21:16:26 | [diff] [blame] | 30 | if sys.version_info[:2] < (3, 5): |
| 31 | raise RuntimeError("Python version >= 3.5 required.") |
Charles Harris | 28eadc0 | 2013-07-11 18:08:49 | [diff] [blame] | 32 | |
Charles Harris | badf290 | 2018-12-07 21:16:26 | [diff] [blame] | 33 | import builtins |
David Cournapeau | 2b51769 | 2009-12-03 15:53:29 | [diff] [blame] | 34 | |
Ralf Gommers | 17716d7 | 2013-12-06 19:45:40 | [diff] [blame] | 35 | |
Travis Oliphant | da9c6da | 2006-01-04 17:31:07 | [diff] [blame] | 36 | CLASSIFIERS = """\ |
Robert Kern | 19da971 | 2008-06-18 22:53:44 | [diff] [blame] | 37 | Development Status :: 5 - Production/Stable |
Travis Oliphant | da9c6da | 2006-01-04 17:31:07 | [diff] [blame] | 38 | Intended Audience :: Science/Research |
| 39 | Intended Audience :: Developers |
| 40 | License :: OSI Approved |
| 41 | Programming Language :: C |
| 42 | Programming Language :: Python |
rgommers | cdac120 | 2011-01-25 14:02:40 | [diff] [blame] | 43 | Programming Language :: Python :: 3 |
Alex Willmer | 193668a | 2015-08-05 09:29:39 | [diff] [blame] | 44 | Programming Language :: Python :: 3.5 |
Charles Harris | b33a5ee | 2016-11-05 19:48:30 | [diff] [blame] | 45 | Programming Language :: Python :: 3.6 |
Ralf Gommers | 943695b | 2018-06-28 02:26:19 | [diff] [blame] | 46 | Programming Language :: Python :: 3.7 |
Grzegorz Bokota | c861a36 | 2019-10-24 18:29:09 | [diff] [blame] | 47 | Programming Language :: Python :: 3.8 |
Jon Dufresne | 334201d | 2019-08-27 04:18:35 | [diff] [blame] | 48 | Programming Language :: Python :: 3 :: Only |
Alex Willmer | 193668a | 2015-08-05 09:29:39 | [diff] [blame] | 49 | Programming Language :: Python :: Implementation :: CPython |
Travis Oliphant | da9c6da | 2006-01-04 17:31:07 | [diff] [blame] | 50 | Topic :: Software Development |
| 51 | Topic :: Scientific/Engineering |
| 52 | Operating System :: Microsoft :: Windows |
| 53 | Operating System :: POSIX |
| 54 | Operating System :: Unix |
| 55 | Operating System :: MacOS |
| 56 | """ |
| 57 | |
Ralf Gommers | 58c1bf7 | 2012-11-05 19:47:23 | [diff] [blame] | 58 | MAJOR = 1 |
Charles Harris | cde9a2e | 2019-06-30 17:34:16 | [diff] [blame] | 59 | MINOR = 18 |
David Cournapeau | 5e041cb | 2009-03-27 11:16:01 | [diff] [blame] | 60 | MICRO = 0 |
Charles Harris | 2410c6d | 2019-12-22 02:55:12 | [diff] [blame] | 61 | ISRELEASED = True |
Charles Harris | f658d56 | 2019-12-06 01:23:32 | [diff] [blame] | 62 | VERSION = '%d.%d.%d' % (MAJOR, MINOR, MICRO) |
Stefan van der Walt | b9a22d7 | 2009-06-17 14:28:03 | [diff] [blame] | 63 | |
Ralf Gommers | 17716d7 | 2013-12-06 19:45:40 | [diff] [blame] | 64 | |
Scott Sinclair | 58e6360 | 2010-11-09 15:09:15 | [diff] [blame] | 65 | # Return the git revision as a string |
| 66 | def git_version(): |
David Cournapeau | 44d92ec | 2009-06-01 05:43:16 | [diff] [blame] | 67 | def _minimal_ext_cmd(cmd): |
| 68 | # construct minimal environment |
| 69 | env = {} |
Robert Kern | c0be995 | 2017-03-09 00:38:54 | [diff] [blame] | 70 | for k in ['SYSTEMROOT', 'PATH', 'HOME']: |
David Cournapeau | 5032b52 | 2009-09-18 10:10:39 | [diff] [blame] | 71 | v = os.environ.get(k) |
| 72 | if v is not None: |
| 73 | env[k] = v |
David Cournapeau | 44d92ec | 2009-06-01 05:43:16 | [diff] [blame] | 74 | # LANGUAGE is used on win32 |
| 75 | env['LANGUAGE'] = 'C' |
| 76 | env['LANG'] = 'C' |
| 77 | env['LC_ALL'] = 'C' |
mattip | 6424fee | 2019-04-25 12:51:55 | [diff] [blame] | 78 | out = subprocess.check_output(cmd, stderr=subprocess.STDOUT, env=env) |
David Cournapeau | 44d92ec | 2009-06-01 05:43:16 | [diff] [blame] | 79 | return out |
| 80 | |
David Cournapeau | 5623a7c | 2009-04-02 16:21:30 | [diff] [blame] | 81 | try: |
Scott Sinclair | 58e6360 | 2010-11-09 15:09:15 | [diff] [blame] | 82 | out = _minimal_ext_cmd(['git', 'rev-parse', 'HEAD']) |
Pauli Virtanen | d1a184c | 2010-11-15 01:00:06 | [diff] [blame] | 83 | GIT_REVISION = out.strip().decode('ascii') |
mattip | 1f1e8f9 | 2019-05-02 02:53:54 | [diff] [blame] | 84 | except (subprocess.SubprocessError, OSError): |
Scott Sinclair | d5ed744 | 2010-11-10 05:19:15 | [diff] [blame] | 85 | GIT_REVISION = "Unknown" |
David Cournapeau | 5e041cb | 2009-03-27 11:16:01 | [diff] [blame] | 86 | |
Seth Troisi | 0498afe | 2019-09-23 19:30:44 | [diff] [blame] | 87 | if not GIT_REVISION: |
| 88 | # this shouldn't happen but apparently can (see gh-8512) |
| 89 | GIT_REVISION = "Unknown" |
| 90 | |
Scott Sinclair | 58e6360 | 2010-11-09 15:09:15 | [diff] [blame] | 91 | return GIT_REVISION |
David Cournapeau | 5e041cb | 2009-03-27 11:16:01 | [diff] [blame] | 92 | |
Ralf Gommers | 4b0ed79 | 2015-12-29 10:29:38 | [diff] [blame] | 93 | # BEFORE importing setuptools, remove MANIFEST. Otherwise it may not be |
| 94 | # properly updated when the contents of directories change (true for distutils, |
| 95 | # not sure about setuptools). |
| 96 | if os.path.exists('MANIFEST'): |
| 97 | os.remove('MANIFEST') |
David Cournapeau | 5bb1aa5 | 2009-03-27 16:39:01 | [diff] [blame] | 98 | |
| 99 | # This is a bit hackish: we are setting a global variable so that the main |
| 100 | # numpy __init__ can detect if it is being loaded by the setup routine, to |
| 101 | # avoid attempting to load components that aren't built yet. While ugly, it's |
| 102 | # a lot more robust than what was previously being used. |
David Cournapeau | 2b51769 | 2009-12-03 15:53:29 | [diff] [blame] | 103 | builtins.__NUMPY_SETUP__ = True |
David Cournapeau | 5bb1aa5 | 2009-03-27 16:39:01 | [diff] [blame] | 104 | |
rgommers | 13212a5 | 2011-03-03 16:13:08 | [diff] [blame] | 105 | |
Ralf Gommers | 17716d7 | 2013-12-06 19:45:40 | [diff] [blame] | 106 | def get_version_info(): |
Ralf Gommers | 87e12c1 | 2011-03-24 15:30:06 | [diff] [blame] | 107 | # Adding the git rev number needs to be done inside write_version_py(), |
| 108 | # otherwise the import of numpy.version messes up the build under Python 3. |
| 109 | FULLVERSION = VERSION |
| 110 | if os.path.exists('.git'): |
| 111 | GIT_REVISION = git_version() |
| 112 | elif os.path.exists('numpy/version.py'): |
| 113 | # must be a source distribution, use existing version file |
Ralf Gommers | cd6d53f | 2011-04-17 14:04:11 | [diff] [blame] | 114 | try: |
| 115 | from numpy.version import git_revision as GIT_REVISION |
| 116 | except ImportError: |
MSeifert04 | 78d269d | 2019-07-01 18:51:40 | [diff] [blame] | 117 | raise ImportError("Unable to import git_revision. Try removing " |
| 118 | "numpy/version.py and the build directory " |
Ralf Gommers | cd6d53f | 2011-04-17 14:04:11 | [diff] [blame] | 119 | "before building.") |
Ralf Gommers | 87e12c1 | 2011-03-24 15:30:06 | [diff] [blame] | 120 | else: |
| 121 | GIT_REVISION = "Unknown" |
| 122 | |
| 123 | if not ISRELEASED: |
Ã…smund Hjulstad | e15f292 | 2015-02-10 17:07:55 | [diff] [blame] | 124 | FULLVERSION += '.dev0+' + GIT_REVISION[:7] |
Ralf Gommers | 87e12c1 | 2011-03-24 15:30:06 | [diff] [blame] | 125 | |
Ralf Gommers | 17716d7 | 2013-12-06 19:45:40 | [diff] [blame] | 126 | return FULLVERSION, GIT_REVISION |
| 127 | |
| 128 | |
| 129 | def write_version_py(filename='numpy/version.py'): |
| 130 | cnt = """ |
| 131 | # THIS FILE IS GENERATED FROM NUMPY SETUP.PY |
Ralf Gommers | 105a498 | 2015-12-29 20:58:36 | [diff] [blame] | 132 | # |
| 133 | # To compare versions robustly, use `numpy.lib.NumpyVersion` |
Ralf Gommers | 17716d7 | 2013-12-06 19:45:40 | [diff] [blame] | 134 | short_version = '%(version)s' |
| 135 | version = '%(version)s' |
| 136 | full_version = '%(full_version)s' |
| 137 | git_revision = '%(git_revision)s' |
| 138 | release = %(isrelease)s |
| 139 | |
| 140 | if not release: |
| 141 | version = full_version |
| 142 | """ |
| 143 | FULLVERSION, GIT_REVISION = get_version_info() |
| 144 | |
David Cournapeau | a2ac985 | 2009-03-27 11:15:36 | [diff] [blame] | 145 | a = open(filename, 'w') |
| 146 | try: |
Scott Sinclair | 58e6360 | 2010-11-09 15:09:15 | [diff] [blame] | 147 | a.write(cnt % {'version': VERSION, |
Charles Harris | 054d93a | 2017-11-29 18:53:21 | [diff] [blame] | 148 | 'full_version': FULLVERSION, |
| 149 | 'git_revision': GIT_REVISION, |
Scott Sinclair | 58e6360 | 2010-11-09 15:09:15 | [diff] [blame] | 150 | 'isrelease': str(ISRELEASED)}) |
David Cournapeau | a2ac985 | 2009-03-27 11:15:36 | [diff] [blame] | 151 | finally: |
| 152 | a.close() |
| 153 | |
Ralf Gommers | 17716d7 | 2013-12-06 19:45:40 | [diff] [blame] | 154 | |
Pearu Peterson | 471196b | 2006-03-31 08:59:36 | [diff] [blame] | 155 | def configuration(parent_package='',top_path=None): |
| 156 | from numpy.distutils.misc_util import Configuration |
| 157 | |
Pearu Peterson | 17d7cfe | 2006-04-04 12:26:14 | [diff] [blame] | 158 | config = Configuration(None, parent_package, top_path) |
Pearu Peterson | 471196b | 2006-03-31 08:59:36 | [diff] [blame] | 159 | config.set_options(ignore_setup_xxx_py=True, |
| 160 | assume_default_configuration=True, |
| 161 | delegate_options_to_subpackages=True, |
| 162 | quiet=True) |
Jarrod Millman | 0b77f0e | 2007-10-29 14:58:18 | [diff] [blame] | 163 | |
Pearu Peterson | 471196b | 2006-03-31 08:59:36 | [diff] [blame] | 164 | config.add_subpackage('numpy') |
Charles Harris | 054d93a | 2017-11-29 18:53:21 | [diff] [blame] | 165 | config.add_data_files(('numpy', 'LICENSE.txt')) |
Jarrod Millman | 0b77f0e | 2007-10-29 14:58:18 | [diff] [blame] | 166 | |
Pearu Peterson | 17d7cfe | 2006-04-04 12:26:14 | [diff] [blame] | 167 | config.get_version('numpy/version.py') # sets config.version |
Travis Oliphant | 00a3587 | 2007-05-31 04:57:01 | [diff] [blame] | 168 | |
Pearu Peterson | 471196b | 2006-03-31 08:59:36 | [diff] [blame] | 169 | return config |
| 170 | |
Ralf Gommers | 4b0ed79 | 2015-12-29 10:29:38 | [diff] [blame] | 171 | |
Julian Taylor | 4cd7274 | 2014-01-29 21:59:19 | [diff] [blame] | 172 | def check_submodules(): |
| 173 | """ verify that the submodules are checked out and clean |
| 174 | use `git submodule update --init`; on failure |
| 175 | """ |
| 176 | if not os.path.exists('.git'): |
| 177 | return |
| 178 | with open('.gitmodules') as f: |
| 179 | for l in f: |
| 180 | if 'path' in l: |
| 181 | p = l.split('=')[-1].strip() |
| 182 | if not os.path.exists(p): |
| 183 | raise ValueError('Submodule %s missing' % p) |
| 184 | |
| 185 | |
| 186 | proc = subprocess.Popen(['git', 'submodule', 'status'], |
| 187 | stdout=subprocess.PIPE) |
| 188 | status, _ = proc.communicate() |
| 189 | status = status.decode("ascii", "replace") |
| 190 | for line in status.splitlines(): |
| 191 | if line.startswith('-') or line.startswith('+'): |
| 192 | raise ValueError('Submodule not clean: %s' % line) |
| 193 | |
Ralf Gommers | 4b0ed79 | 2015-12-29 10:29:38 | [diff] [blame] | 194 | |
Ralf Gommers | a08fb60 | 2019-05-03 14:44:23 | [diff] [blame] | 195 | class concat_license_files(): |
Ralf Gommers | 3341590 | 2019-05-07 09:00:50 | [diff] [blame] | 196 | """Merge LICENSE.txt and LICENSES_bundled.txt for sdist creation |
Ralf Gommers | a08fb60 | 2019-05-03 14:44:23 | [diff] [blame] | 197 | |
| 198 | Done this way to keep LICENSE.txt in repo as exact BSD 3-clause (see |
| 199 | gh-13447). This makes GitHub state correctly how NumPy is licensed. |
| 200 | """ |
| 201 | def __init__(self): |
| 202 | self.f1 = 'LICENSE.txt' |
Ralf Gommers | 3341590 | 2019-05-07 09:00:50 | [diff] [blame] | 203 | self.f2 = 'LICENSES_bundled.txt' |
Ralf Gommers | a08fb60 | 2019-05-03 14:44:23 | [diff] [blame] | 204 | |
| 205 | def __enter__(self): |
Ralf Gommers | 3341590 | 2019-05-07 09:00:50 | [diff] [blame] | 206 | """Concatenate files and remove LICENSES_bundled.txt""" |
Ralf Gommers | a08fb60 | 2019-05-03 14:44:23 | [diff] [blame] | 207 | with open(self.f1, 'r') as f1: |
| 208 | self.bsd_text = f1.read() |
| 209 | |
| 210 | with open(self.f1, 'a') as f1: |
| 211 | with open(self.f2, 'r') as f2: |
| 212 | self.bundled_text = f2.read() |
| 213 | f1.write('\n\n') |
| 214 | f1.write(self.bundled_text) |
| 215 | |
Ralf Gommers | a08fb60 | 2019-05-03 14:44:23 | [diff] [blame] | 216 | def __exit__(self, exception_type, exception_value, traceback): |
| 217 | """Restore content of both files""" |
| 218 | with open(self.f1, 'w') as f: |
| 219 | f.write(self.bsd_text) |
| 220 | |
Ralf Gommers | a08fb60 | 2019-05-03 14:44:23 | [diff] [blame] | 221 | |
Ralf Gommers | 6770f98 | 2016-01-27 20:34:28 | [diff] [blame] | 222 | from distutils.command.sdist import sdist |
Julian Taylor | 4cd7274 | 2014-01-29 21:59:19 | [diff] [blame] | 223 | class sdist_checked(sdist): |
| 224 | """ check submodules on sdist to prevent incomplete tarballs """ |
| 225 | def run(self): |
| 226 | check_submodules() |
Ralf Gommers | a08fb60 | 2019-05-03 14:44:23 | [diff] [blame] | 227 | with concat_license_files(): |
| 228 | sdist.run(self) |
Travis Oliphant | 14db419 | 2005-09-14 22:08:46 | [diff] [blame] | 229 | |
Ralf Gommers | 4b0ed79 | 2015-12-29 10:29:38 | [diff] [blame] | 230 | |
Julian Taylor | c9fd634 | 2014-04-05 11:13:13 | [diff] [blame] | 231 | def generate_cython(): |
| 232 | cwd = os.path.abspath(os.path.dirname(__file__)) |
| 233 | print("Cythonizing sources") |
mattip | 4e6a812 | 2019-05-23 04:54:47 | [diff] [blame] | 234 | for d in ('random',): |
mattip | fa8af41 | 2019-03-20 10:39:53 | [diff] [blame] | 235 | p = subprocess.call([sys.executable, |
| 236 | os.path.join(cwd, 'tools', 'cythonize.py'), |
mattip | c53b2eb | 2019-04-09 21:50:42 | [diff] [blame] | 237 | 'numpy/{0}'.format(d)], |
mattip | fa8af41 | 2019-03-20 10:39:53 | [diff] [blame] | 238 | cwd=cwd) |
| 239 | if p != 0: |
| 240 | raise RuntimeError("Running cythonize failed!") |
Julian Taylor | c9fd634 | 2014-04-05 11:13:13 | [diff] [blame] | 241 | |
Ralf Gommers | 4b0ed79 | 2015-12-29 10:29:38 | [diff] [blame] | 242 | |
Ralf Gommers | b9f4809 | 2015-12-29 11:05:30 | [diff] [blame] | 243 | def parse_setuppy_commands(): |
Ralf Gommers | 99e99e9 | 2015-12-29 14:24:22 | [diff] [blame] | 244 | """Check the commands and respond appropriately. Disable broken commands. |
| 245 | |
| 246 | Return a boolean value for whether or not to run the build or not (avoid |
| 247 | parsing Cython and template files if False). |
| 248 | """ |
Eric Wieser | b8b2a0e | 2018-03-12 08:29:52 | [diff] [blame] | 249 | args = sys.argv[1:] |
| 250 | |
| 251 | if not args: |
Ralf Gommers | b9f4809 | 2015-12-29 11:05:30 | [diff] [blame] | 252 | # User forgot to give an argument probably, let setuptools handle that. |
Ralf Gommers | 99e99e9 | 2015-12-29 14:24:22 | [diff] [blame] | 253 | return True |
Ralf Gommers | b9f4809 | 2015-12-29 11:05:30 | [diff] [blame] | 254 | |
Ralf Gommers | 99e99e9 | 2015-12-29 14:24:22 | [diff] [blame] | 255 | info_commands = ['--help-commands', '--name', '--version', '-V', |
| 256 | '--fullname', '--author', '--author-email', |
| 257 | '--maintainer', '--maintainer-email', '--contact', |
| 258 | '--contact-email', '--url', '--license', '--description', |
| 259 | '--long-description', '--platforms', '--classifiers', |
| 260 | '--keywords', '--provides', '--requires', '--obsoletes'] |
Ralf Gommers | 99e99e9 | 2015-12-29 14:24:22 | [diff] [blame] | 261 | |
| 262 | for command in info_commands: |
Eric Wieser | b8b2a0e | 2018-03-12 08:29:52 | [diff] [blame] | 263 | if command in args: |
Ralf Gommers | 99e99e9 | 2015-12-29 14:24:22 | [diff] [blame] | 264 | return False |
| 265 | |
| 266 | # Note that 'alias', 'saveopts' and 'setopt' commands also seem to work |
| 267 | # fine as they are, but are usually used together with one of the commands |
| 268 | # below and not standalone. Hence they're not added to good_commands. |
| 269 | good_commands = ('develop', 'sdist', 'build', 'build_ext', 'build_py', |
Ralf Gommers | ab5c6d0 | 2016-01-16 14:21:23 | [diff] [blame] | 270 | 'build_clib', 'build_scripts', 'bdist_wheel', 'bdist_rpm', |
mattip | 2e4af96 | 2019-09-19 20:47:29 | [diff] [blame] | 271 | 'bdist_wininst', 'bdist_msi', 'bdist_mpkg', 'build_src') |
Ralf Gommers | 99e99e9 | 2015-12-29 14:24:22 | [diff] [blame] | 272 | |
Ralf Gommers | b9f4809 | 2015-12-29 11:05:30 | [diff] [blame] | 273 | for command in good_commands: |
Eric Wieser | b8b2a0e | 2018-03-12 08:29:52 | [diff] [blame] | 274 | if command in args: |
Ralf Gommers | 99e99e9 | 2015-12-29 14:24:22 | [diff] [blame] | 275 | return True |
Ralf Gommers | b9f4809 | 2015-12-29 11:05:30 | [diff] [blame] | 276 | |
Ralf Gommers | ab5c6d0 | 2016-01-16 14:21:23 | [diff] [blame] | 277 | # The following commands are supported, but we need to show more |
Ralf Gommers | 99e99e9 | 2015-12-29 14:24:22 | [diff] [blame] | 278 | # useful messages to the user |
Eric Wieser | b8b2a0e | 2018-03-12 08:29:52 | [diff] [blame] | 279 | if 'install' in args: |
Ralf Gommers | 99e99e9 | 2015-12-29 14:24:22 | [diff] [blame] | 280 | print(textwrap.dedent(""" |
| 281 | Note: if you need reliable uninstall behavior, then install |
| 282 | with pip instead of using `setup.py install`: |
| 283 | |
| 284 | - `pip install .` (from a git repo or downloaded source |
| 285 | release) |
Pierre de Buyl | 3f6672a | 2016-09-06 12:54:08 | [diff] [blame] | 286 | - `pip install numpy` (last NumPy release on PyPi) |
Ralf Gommers | 99e99e9 | 2015-12-29 14:24:22 | [diff] [blame] | 287 | |
| 288 | """)) |
| 289 | return True |
| 290 | |
Eric Wieser | b8b2a0e | 2018-03-12 08:29:52 | [diff] [blame] | 291 | if '--help' in args or '-h' in sys.argv[1]: |
Ralf Gommers | 99e99e9 | 2015-12-29 14:24:22 | [diff] [blame] | 292 | print(textwrap.dedent(""" |
Pierre de Buyl | 3f6672a | 2016-09-06 12:54:08 | [diff] [blame] | 293 | NumPy-specific help |
Ralf Gommers | 99e99e9 | 2015-12-29 14:24:22 | [diff] [blame] | 294 | ------------------- |
| 295 | |
Pierre de Buyl | 3f6672a | 2016-09-06 12:54:08 | [diff] [blame] | 296 | To install NumPy from here with reliable uninstall, we recommend |
| 297 | that you use `pip install .`. To install the latest NumPy release |
Ralf Gommers | 99e99e9 | 2015-12-29 14:24:22 | [diff] [blame] | 298 | from PyPi, use `pip install numpy`. |
| 299 | |
| 300 | For help with build/installation issues, please ask on the |
| 301 | numpy-discussion mailing list. If you are sure that you have run |
| 302 | into a bug, please report it at https://github.com/numpy/numpy/issues. |
| 303 | |
| 304 | Setuptools commands help |
| 305 | ------------------------ |
| 306 | """)) |
| 307 | return False |
| 308 | |
Eric Wieser | b8b2a0e | 2018-03-12 08:29:52 | [diff] [blame] | 309 | |
Ralf Gommers | 99e99e9 | 2015-12-29 14:24:22 | [diff] [blame] | 310 | # The following commands aren't supported. They can only be executed when |
| 311 | # the user explicitly adds a --force command-line argument. |
Ralf Gommers | b9f4809 | 2015-12-29 11:05:30 | [diff] [blame] | 312 | bad_commands = dict( |
| 313 | test=""" |
| 314 | `setup.py test` is not supported. Use one of the following |
| 315 | instead: |
| 316 | |
| 317 | - `python runtests.py` (to build and test) |
| 318 | - `python runtests.py --no-build` (to test installed numpy) |
| 319 | - `>>> numpy.test()` (run tests for installed numpy |
| 320 | from within an interpreter) |
| 321 | """, |
| 322 | upload=""" |
| 323 | `setup.py upload` is not supported, because it's insecure. |
| 324 | Instead, build what you want to upload and upload those files |
| 325 | with `twine upload -s <filenames>` instead. |
| 326 | """, |
| 327 | upload_docs="`setup.py upload_docs` is not supported", |
| 328 | easy_install="`setup.py easy_install` is not supported", |
| 329 | clean=""" |
| 330 | `setup.py clean` is not supported, use one of the following instead: |
| 331 | |
| 332 | - `git clean -xdf` (cleans all files) |
| 333 | - `git clean -Xdf` (cleans all versioned files, doesn't touch |
| 334 | files that aren't checked into the git repo) |
| 335 | """, |
| 336 | check="`setup.py check` is not supported", |
| 337 | register="`setup.py register` is not supported", |
| 338 | bdist_dumb="`setup.py bdist_dumb` is not supported", |
Ralf Gommers | 99e99e9 | 2015-12-29 14:24:22 | [diff] [blame] | 339 | bdist="`setup.py bdist` is not supported", |
| 340 | build_sphinx=""" |
| 341 | `setup.py build_sphinx` is not supported, use the |
| 342 | Makefile under doc/""", |
| 343 | flake8="`setup.py flake8` is not supported, use flake8 standalone", |
Ralf Gommers | b9f4809 | 2015-12-29 11:05:30 | [diff] [blame] | 344 | ) |
Ralf Gommers | 99e99e9 | 2015-12-29 14:24:22 | [diff] [blame] | 345 | bad_commands['nosetests'] = bad_commands['test'] |
Luca Mussi | 69d2cc8 | 2016-04-07 11:24:49 | [diff] [blame] | 346 | for command in ('upload_docs', 'easy_install', 'bdist', 'bdist_dumb', |
Ralf Gommers | 99e99e9 | 2015-12-29 14:24:22 | [diff] [blame] | 347 | 'register', 'check', 'install_data', 'install_headers', |
| 348 | 'install_lib', 'install_scripts', ): |
| 349 | bad_commands[command] = "`setup.py %s` is not supported" % command |
| 350 | |
Ralf Gommers | b9f4809 | 2015-12-29 11:05:30 | [diff] [blame] | 351 | for command in bad_commands.keys(): |
Eric Wieser | b8b2a0e | 2018-03-12 08:29:52 | [diff] [blame] | 352 | if command in args: |
Ralf Gommers | b9f4809 | 2015-12-29 11:05:30 | [diff] [blame] | 353 | print(textwrap.dedent(bad_commands[command]) + |
| 354 | "\nAdd `--force` to your command to use it anyway if you " |
| 355 | "must (unsupported).\n") |
| 356 | sys.exit(1) |
| 357 | |
Eric Wieser | b8b2a0e | 2018-03-12 08:29:52 | [diff] [blame] | 358 | # Commands that do more than print info, but also don't need Cython and |
| 359 | # template parsing. |
| 360 | other_commands = ['egg_info', 'install_egg_info', 'rotate'] |
| 361 | for command in other_commands: |
| 362 | if command in args: |
| 363 | return False |
| 364 | |
Ralf Gommers | 99e99e9 | 2015-12-29 14:24:22 | [diff] [blame] | 365 | # If we got here, we didn't detect what setup.py command was given |
| 366 | import warnings |
| 367 | warnings.warn("Unrecognized setuptools command, proceeding with " |
Sebastian Berg | 7884a8c | 2016-01-23 14:58:58 | [diff] [blame] | 368 | "generating Cython sources and expanding templates", stacklevel=2) |
Ralf Gommers | 99e99e9 | 2015-12-29 14:24:22 | [diff] [blame] | 369 | return True |
Ralf Gommers | b9f4809 | 2015-12-29 11:05:30 | [diff] [blame] | 370 | |
| 371 | |
Ralf Gommers | 17716d7 | 2013-12-06 19:45:40 | [diff] [blame] | 372 | def setup_package(): |
mattip | 8b26655 | 2019-07-03 22:24:42 | [diff] [blame] | 373 | src_path = os.path.dirname(os.path.abspath(__file__)) |
Pauli Virtanen | 6815943 | 2009-12-06 11:56:18 | [diff] [blame] | 374 | old_path = os.getcwd() |
| 375 | os.chdir(src_path) |
| 376 | sys.path.insert(0, src_path) |
| 377 | |
Pauli Virtanen | 0131218 | 2010-11-23 16:50:54 | [diff] [blame] | 378 | # Rewrite the version file everytime |
| 379 | write_version_py() |
| 380 | |
Charles Harris | f22a33b | 2018-08-22 17:57:48 | [diff] [blame] | 381 | # The f2py scripts that will be installed |
| 382 | if sys.platform == 'win32': |
| 383 | f2py_cmds = [ |
| 384 | 'f2py = numpy.f2py.f2py2e:main', |
| 385 | ] |
| 386 | else: |
| 387 | f2py_cmds = [ |
| 388 | 'f2py = numpy.f2py.f2py2e:main', |
| 389 | 'f2py%s = numpy.f2py.f2py2e:main' % sys.version_info[:1], |
| 390 | 'f2py%s.%s = numpy.f2py.f2py2e:main' % sys.version_info[:2], |
| 391 | ] |
| 392 | |
Ralf Gommers | 17716d7 | 2013-12-06 19:45:40 | [diff] [blame] | 393 | metadata = dict( |
| 394 | name = 'numpy', |
| 395 | maintainer = "NumPy Developers", |
Ralf Gommers | 46f7dca | 2017-03-26 07:52:46 | [diff] [blame] | 396 | maintainer_email = "numpy-discussion@python.org", |
Ralf Gommers | 17716d7 | 2013-12-06 19:45:40 | [diff] [blame] | 397 | description = DOCLINES[0], |
| 398 | long_description = "\n".join(DOCLINES[2:]), |
Mike Toews | 83828f5 | 2018-06-16 06:18:19 | [diff] [blame] | 399 | url = "https://www.numpy.org", |
Ralf Gommers | 17716d7 | 2013-12-06 19:45:40 | [diff] [blame] | 400 | author = "Travis E. Oliphant et al.", |
Charles Harris | ec5985d | 2018-01-10 18:00:11 | [diff] [blame] | 401 | download_url = "https://pypi.python.org/pypi/numpy", |
Jarrod Millman | 0486b6d | 2019-04-12 01:11:21 | [diff] [blame] | 402 | project_urls={ |
| 403 | "Bug Tracker": "https://github.com/numpy/numpy/issues", |
| 404 | "Documentation": "https://docs.scipy.org/doc/numpy/", |
| 405 | "Source Code": "https://github.com/numpy/numpy", |
| 406 | }, |
Ralf Gommers | 17716d7 | 2013-12-06 19:45:40 | [diff] [blame] | 407 | license = 'BSD', |
| 408 | classifiers=[_f for _f in CLASSIFIERS.split('\n') if _f], |
| 409 | platforms = ["Windows", "Linux", "Solaris", "Mac OS-X", "Unix"], |
| 410 | test_suite='nose.collector', |
mattip | 2e4af96 | 2019-09-19 20:47:29 | [diff] [blame] | 411 | cmdclass={"sdist": sdist_checked, |
mattip | 2e4af96 | 2019-09-19 20:47:29 | [diff] [blame] | 412 | }, |
Juan Luis Cano RodrÃguez | 4adf52e | 2018-12-27 00:22:20 | [diff] [blame] | 413 | python_requires='>=3.5', |
Nathaniel J. Smith | f46e716 | 2018-01-23 08:02:04 | [diff] [blame] | 414 | zip_safe=False, |
Charles Harris | f22a33b | 2018-08-22 17:57:48 | [diff] [blame] | 415 | entry_points={ |
| 416 | 'console_scripts': f2py_cmds |
| 417 | }, |
Ralf Gommers | 17716d7 | 2013-12-06 19:45:40 | [diff] [blame] | 418 | ) |
| 419 | |
Ralf Gommers | 99e99e9 | 2015-12-29 14:24:22 | [diff] [blame] | 420 | if "--force" in sys.argv: |
| 421 | run_build = True |
Ralf Gommers | 20c3c2a | 2017-06-20 10:09:40 | [diff] [blame] | 422 | sys.argv.remove('--force') |
Ralf Gommers | 99e99e9 | 2015-12-29 14:24:22 | [diff] [blame] | 423 | else: |
| 424 | # Raise errors for unsupported commands, improve help output, etc. |
| 425 | run_build = parse_setuppy_commands() |
Ralf Gommers | b9f4809 | 2015-12-29 11:05:30 | [diff] [blame] | 426 | |
| 427 | from setuptools import setup |
Ralf Gommers | 99e99e9 | 2015-12-29 14:24:22 | [diff] [blame] | 428 | if run_build: |
Ralf Gommers | 17716d7 | 2013-12-06 19:45:40 | [diff] [blame] | 429 | from numpy.distutils.core import setup |
Julian Taylor | c9fd634 | 2014-04-05 11:13:13 | [diff] [blame] | 430 | cwd = os.path.abspath(os.path.dirname(__file__)) |
Ralf Gommers | d630d96 | 2019-09-08 05:01:41 | [diff] [blame] | 431 | if not 'sdist' in sys.argv: |
| 432 | # Generate Cython sources, unless we're generating an sdist |
Julian Taylor | c9fd634 | 2014-04-05 11:13:13 | [diff] [blame] | 433 | generate_cython() |
Ralf Gommers | 4b0ed79 | 2015-12-29 10:29:38 | [diff] [blame] | 434 | |
Ralf Gommers | 17716d7 | 2013-12-06 19:45:40 | [diff] [blame] | 435 | metadata['configuration'] = configuration |
Ralf Gommers | 99e99e9 | 2015-12-29 14:24:22 | [diff] [blame] | 436 | else: |
| 437 | # Version number is added to metadata inside configuration() if build |
| 438 | # is run. |
| 439 | metadata['version'] = get_version_info()[0] |
Pauli Virtanen | 6815943 | 2009-12-06 11:56:18 | [diff] [blame] | 440 | |
Pearu Peterson | e8fa013 | 2003-03-07 18:08:28 | [diff] [blame] | 441 | try: |
Ralf Gommers | 17716d7 | 2013-12-06 19:45:40 | [diff] [blame] | 442 | setup(**metadata) |
Pearu Peterson | e8fa013 | 2003-03-07 18:08:28 | [diff] [blame] | 443 | finally: |
| 444 | del sys.path[0] |
| 445 | os.chdir(old_path) |
Travis Oliphant | 14db419 | 2005-09-14 22:08:46 | [diff] [blame] | 446 | return |
Pearu Peterson | c415fd1 | 2002-11-18 22:39:31 | [diff] [blame] | 447 | |
Ralf Gommers | 17716d7 | 2013-12-06 19:45:40 | [diff] [blame] | 448 | |
Travis Oliphant | 14db419 | 2005-09-14 22:08:46 | [diff] [blame] | 449 | if __name__ == '__main__': |
Pearu Peterson | e8fa013 | 2003-03-07 18:08:28 | [diff] [blame] | 450 | setup_package() |
Ralf Gommers | bbee747 | 2016-08-21 05:23:35 | [diff] [blame] | 451 | # This may avoid problems where numpy is installed via ``*_requires`` by |
| 452 | # setuptools, the global namespace isn't reset properly, and then numpy is |
| 453 | # imported later (which will then fail to load numpy extension modules). |
| 454 | # See gh-7956 for details |
| 455 | del builtins.__NUMPY_SETUP__ |