pyproject.toml, setup.py: Declare backend-path (#14313)

Replacing `sys.path.insert(0, ".")` in `setup.py` by declaring a custom
PEP-517 build system.

_build_meta.py

@@ -0,0 +1,2 b''
+# See https://setuptools.pypa.io/en/latest/build_meta.html#dynamic-build-dependencies-and-other-build-meta-tweaks
+from setuptools.build_meta import *

MANIFEST.in

@@ -1,47 +1,48 b''
 include README.rst
 include COPYING.rst
 include LICENSE
 include setupbase.py
+include _build_meta.py
 include MANIFEST.in
 include py.typed
 include .mailmap
 include .flake8
 include .pre-commit-config.yaml
 include long_description.rst
 
 recursive-exclude tools *
 exclude tools
 exclude CONTRIBUTING.md
 exclude .editorconfig
 exclude SECURITY.md
 exclude .readthedocs.yaml
 
 graft scripts
 
 # Load main dir but exclude things we don't want in the distro
 graft IPython
 
 # Documentation
 graft docs
 exclude docs/\#*
 exclude docs/man/*.1.gz
 
 exclude .git-blame-ignore-revs
 
 # Examples
 graft examples
 
 # docs subdirs we want to skip
 prune docs/build
 prune docs/gh-pages
 prune docs/dist
 
 # Patterns to exclude from any directory
 global-exclude *~
 global-exclude *.flc
 global-exclude *.yml
 global-exclude *.pyc
 global-exclude *.pyo
 global-exclude .dircopy.log
 global-exclude .git
 global-exclude .ipynb_checkpoints

pyproject.toml

@@ -1,84 +1,87 b''
 [build-system]
 requires = ["setuptools >= 51.0.0"]
-build-backend = "setuptools.build_meta"
+# We need access to the 'setupbase' module at build time.
+# Hence we declare a custom build backend.
+build-backend = "_build_meta"  # just re-exports setuptools.build_meta definitions
+backend-path = ["."]
 
 [tool.mypy]
 python_version = "3.10"
 ignore_missing_imports = true
 follow_imports = 'silent'
 exclude = [
    'test_\.+\.py',
    'IPython.utils.tests.test_wildcard',
    'testing',
    'tests',
    'PyColorize.py',
    '_process_win32_controller.py',
    'IPython/core/application.py',
    'IPython/core/completerlib.py',
    'IPython/core/displaypub.py',
    'IPython/core/historyapp.py',
    #'IPython/core/interactiveshell.py',
    'IPython/core/magic.py',
    'IPython/core/profileapp.py',
    # 'IPython/core/ultratb.py',
    'IPython/lib/deepreload.py',
    'IPython/lib/pretty.py',
    'IPython/sphinxext/ipython_directive.py',
    'IPython/terminal/ipapp.py',
    'IPython/utils/_process_win32.py',
    'IPython/utils/path.py',
    'IPython/utils/timing.py',
    'IPython/utils/text.py'
 ]
 
 [tool.pytest.ini_options]
 addopts = [
    "--durations=10",
    "-pIPython.testing.plugin.pytest_ipdoctest",
    "--ipdoctest-modules",
    "--ignore=docs",
    "--ignore=examples",
    "--ignore=htmlcov",
    "--ignore=ipython_kernel",
    "--ignore=ipython_parallel",
    "--ignore=results",
    "--ignore=tmp",
    "--ignore=tools",
    "--ignore=traitlets",
    "--ignore=IPython/core/tests/daft_extension",
    "--ignore=IPython/sphinxext",
    "--ignore=IPython/terminal/pt_inputhooks",
    "--ignore=IPython/__main__.py",
    "--ignore=IPython/external/qt_for_kernel.py",
    "--ignore=IPython/html/widgets/widget_link.py",
    "--ignore=IPython/html/widgets/widget_output.py",
    "--ignore=IPython/terminal/console.py",
    "--ignore=IPython/utils/_process_cli.py",
    "--ignore=IPython/utils/_process_posix.py",
    "--ignore=IPython/utils/_process_win32.py",
    "--ignore=IPython/utils/_process_win32_controller.py",
    "--ignore=IPython/utils/daemonize.py",
    "--ignore=IPython/utils/eventful.py",
    "--ignore=IPython/kernel",
    "--ignore=IPython/consoleapp.py",
    "--ignore=IPython/core/inputsplitter.py",
    "--ignore=IPython/lib/kernel.py",
    "--ignore=IPython/utils/jsonutil.py",
    "--ignore=IPython/utils/localinterfaces.py",
    "--ignore=IPython/utils/log.py",
    "--ignore=IPython/utils/signatures.py",
    "--ignore=IPython/utils/traitlets.py",
    "--ignore=IPython/utils/version.py"
 ]
 doctest_optionflags = [
    "NORMALIZE_WHITESPACE",
    "ELLIPSIS"
 ]
 ipdoctest_optionflags = [
    "NORMALIZE_WHITESPACE",
    "ELLIPSIS"
 ]
 asyncio_mode = "strict"
 
 [tool.pyright]
 pythonPlatform="All"

setup.py

@@ -1,159 +1,158 b''
 # -*- coding: utf-8 -*-
 """Setup script for IPython.
 
 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-2011, IPython Development Team.
 #  Copyright (c) 2001-2007, Fernando Perez <[e-mail]>
 #  Copyright (c) 2001, Janko Hauser <[e-mail]>
 #  Copyright (c) 2001, Nathaniel Gray <[e-mail]>
 #
 #  Distributed under the terms of the Modified BSD License.
 #
 #  The full license is in the file COPYING.rst, distributed with this software.
 #-----------------------------------------------------------------------------
 
 import os
 import sys
 
 # **Python version check**
 #
 # This check is also made in IPython/__init__, don't forget to update both when
 # changing Python version requirements.
 if sys.version_info < (3, 10):
     pip_message = 'This may be due to an out of date pip. Make sure you have pip >= 9.0.1.'
     try:
         import pip
         pip_version = tuple([int(x) for x in pip.__version__.split('.')[:3]])
         if pip_version < (9, 0, 1) :
             pip_message = 'Your pip version is out of date, please install pip >= 9.0.1. '\
             'pip {} detected.'.format(pip.__version__)
         else:
             # pip is new enough - it must be something else
             pip_message = ''
     except Exception:
         pass
 
 
     error = """
 IPython 8.19+ supports Python 3.10 and above, following SPEC0
 IPython 8.13+ supports Python 3.9 and above, following NEP 29.
 IPython 8.0-8.12 supports Python 3.8 and above, following NEP 29.
 When using Python 2.7, please install IPython 5.x LTS Long Term Support version.
 Python 3.3 and 3.4 were supported up to IPython 6.x.
 Python 3.5 was supported with IPython 7.0 to 7.9.
 Python 3.6 was supported with IPython up to 7.16.
 Python 3.7 was still supported with the 7.x branch.
 
 See IPython `README.rst` file for more information:
 
     https://github.com/ipython/ipython/blob/main/README.rst
 
 Python {py} detected.
 {pip}
 """.format(
         py=sys.version_info, pip=pip_message
     )
 
     print(error, file=sys.stderr)
     sys.exit(1)
 
 # At least we're on the python version we need, move on.
 
 from setuptools import setup
 
 # Our own imports
-sys.path.insert(0, ".")
 
 from setupbase import target_update, find_entry_points
 
 from setupbase import (
     setup_args,
     check_package_data_first,
     find_data_files,
     git_prebuild,
     install_symlinked,
     install_lib_symlink,
     install_scripts_for_symlink,
     unsymlink,
 )
 
 #-------------------------------------------------------------------------------
 # Handle OS specific things
 #-------------------------------------------------------------------------------
 
 if os.name in ('nt','dos'):
     os_name = 'windows'
 else:
     os_name = os.name
 
 # Under Windows, 'sdist' has not been supported.  Now that the docs build with
 # Sphinx it might work, but let's not turn it on until someone confirms that it
 # actually works.
 if os_name == 'windows' and 'sdist' in sys.argv:
     print('The sdist command is not available under Windows.  Exiting.')
     sys.exit(1)
 
 
 #-------------------------------------------------------------------------------
 # Things related to the IPython documentation
 #-------------------------------------------------------------------------------
 
 # update the manuals when building a source dist
 if len(sys.argv) >= 2 and sys.argv[1] in ('sdist','bdist_rpm'):
 
     # List of things to be updated. Each entry is a triplet of args for
     # target_update()
     to_update = [
         (
             "docs/man/ipython.1.gz",
             ["docs/man/ipython.1"],
             "cd docs/man && python -m gzip --best ipython.1",
         ),
     ]
 
 
     [ target_update(*t) for t in to_update ]
 
 #---------------------------------------------------------------------------
 # Find all the packages, package data, and data_files
 #---------------------------------------------------------------------------
 
 data_files = find_data_files()
 
 setup_args['data_files'] = data_files
 
 #---------------------------------------------------------------------------
 # custom distutils commands
 #---------------------------------------------------------------------------
 # imports here, so they are after setuptools import if there was one
 from setuptools.command.sdist import sdist
 
 setup_args['cmdclass'] = {
     'build_py': \
             check_package_data_first(git_prebuild('IPython')),
     'sdist' : git_prebuild('IPython', sdist),
     'symlink': install_symlinked,
     'install_lib_symlink': install_lib_symlink,
     'install_scripts_sym': install_scripts_for_symlink,
     'unsymlink': unsymlink,
 }
 
 setup_args["entry_points"] = {
     "console_scripts": find_entry_points(),
     "pygments.lexers": [
         "ipythonconsole = IPython.lib.lexers:IPythonConsoleLexer",
         "ipython = IPython.lib.lexers:IPythonLexer",
         "ipython3 = IPython.lib.lexers:IPython3Lexer",
     ],
 }
 
 #---------------------------------------------------------------------------
 # Do the actual setup now
 #---------------------------------------------------------------------------
 
 if __name__ == "__main__":
     setup(**setup_args)