pyproject.toml: Move metadata, setuptools config here from setup.cfg (#14326)

Modernizing metadata, with the help of ini2toml.

.github/workflows/nightly-wheel-build.yml

@@ -1,34 +1,34 b''
 name: Nightly Wheel builder
 on:
   workflow_dispatch:
   schedule:
     # this cron is ran every Sunday at midnight UTC
     - cron: '0 0 * * 0'
 
 jobs:
   upload_anaconda:
     name: Upload to Anaconda
     runs-on: ubuntu-latest
     # The artifacts cannot be uploaded on PRs
     if: github.event_name != 'pull_request'
 
     steps:
       - uses: actions/checkout@v3
       - name: Set up Python
         uses: actions/setup-python@v4
         with:
           python-version: "3.10"
           cache: pip
           cache-dependency-path: |
-            setup.cfg
+            pyproject.toml
       - name: Try building with Python build
         if: runner.os != 'Windows'  # setup.py does not support sdist on Windows
         run: |
           python -m pip install build
           python -m build
 
       - name: Upload wheel
         uses: scientific-python/upload-nightly-action@main
         with:
           artifacts_path: dist
           anaconda_nightly_upload_token: ${{secrets.UPLOAD_TOKEN}}

.github/workflows/test.yml

@@ -1,98 +1,98 b''
 name: Run tests
 
 on:
   push:
     branches:
       - main
       - '*.x'
   pull_request:
   # Run weekly on Monday at 1:23 UTC
   schedule:
   - cron:  '23 1 * * 1'
   workflow_dispatch:
 
 
 jobs:
   test:
     runs-on: ${{ matrix.os }}
     strategy:
       fail-fast: false
       matrix:
         os: [ubuntu-latest, windows-latest]
         python-version: ["3.10", "3.11", "3.12"]
         deps: [test_extra]
         # Test all on ubuntu, test ends on macos
         include:
           - os: macos-latest
             python-version: "3.10"
             deps: test_extra
           - os: macos-latest
             python-version: "3.11"
             deps: test_extra
           # Tests minimal dependencies set
           - os: ubuntu-latest
             python-version: "3.11"
             deps: test
           # Tests latest development Python version
           - os: ubuntu-latest
             python-version: "3.13-dev"
             deps: test
           # Installing optional dependencies stuff takes ages on PyPy
           - os: ubuntu-latest
             python-version: "pypy-3.10"
             deps: test
           - os: windows-latest
             python-version: "pypy-3.10"
             deps: test
           - os: macos-latest
             python-version: "pypy-3.10"
             deps: test
 
     steps:
     - uses: actions/checkout@v3
     - name: Set up Python ${{ matrix.python-version }}
       uses: actions/setup-python@v4
       with:
         python-version: ${{ matrix.python-version }}
         cache: pip
         cache-dependency-path: |
-          setup.cfg
+          pyproject.toml
     - name: Install latex
       if: runner.os == 'Linux' && matrix.deps == 'test_extra'
       run: echo "disable latex for now, issues in mirros" #sudo apt-get -yq -o Acquire::Retries=3 --no-install-suggests --no-install-recommends install texlive dvipng
     - name: Install and update Python dependencies (binary only)
       if: ${{ ! contains( matrix.python-version, 'dev' ) }}
       run: |
         python -m pip install --only-binary ':all:' --upgrade pip setuptools wheel build
         python -m pip install --only-binary ':all:' --no-binary curio --upgrade -e .[${{ matrix.deps }}]
         python -m pip install --only-binary ':all:' --upgrade check-manifest pytest-cov  pytest-json-report 'pytest<8'
     - name: Install and update Python dependencies (dev?)
       if: ${{ contains( matrix.python-version, 'dev' ) }}
       run: |
         python -m pip install --pre --upgrade pip setuptools wheel build
         python -m pip install --pre --extra-index-url https://pypi.anaconda.org/scientific-python-nightly-wheels/simple --no-binary curio --upgrade -e .[${{ matrix.deps }}]
         python -m pip install --pre --extra-index-url https://pypi.anaconda.org/scientific-python-nightly-wheels/simple --upgrade check-manifest pytest-cov  pytest-json-report
     - name: Try building with Python build
       if: runner.os != 'Windows'  # setup.py does not support sdist on Windows
       run: |
         python -m build
         shasum -a 256 dist/*
     - name: Check manifest
       if: runner.os != 'Windows'  # setup.py does not support sdist on Windows
       run: check-manifest
     - name: pytest
       env:
         COLUMNS: 120
       run: |
         pytest --color=yes -raXxs ${{ startsWith(matrix.python-version, 'pypy') && ' ' || '--cov --cov-report=xml' }} --json-report --json-report-file=./report-${{ matrix.python-version }}-${{runner.os}}.json --maxfail=15
     - uses: actions/upload-artifact@v3
       with:
           name: upload pytest timing reports as json
           path: |
             ./report-*.json
 
     - name: Upload coverage to Codecov
       uses: codecov/codecov-action@v3
       with:
          name: Test
          files: /home/runner/work/ipython/ipython/coverage.xml

MANIFEST.in

@@ -1,48 +1,47 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,78 +1,196 b''
 [build-system]
-requires = ["setuptools >= 51.0.0"]
+requires = ["setuptools>=61.2"]
 # 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 = ["."]
 
+[project]
+name = "ipython"
+description = "IPython: Productive Interactive Computing"
+keywords = ["Interactive", "Interpreter", "Shell", "Embedding"]
+classifiers = [
+    "Framework :: IPython",
+    "Framework :: Jupyter",
+    "Intended Audience :: Developers",
+    "Intended Audience :: Science/Research",
+    "License :: OSI Approved :: BSD License",
+    "Programming Language :: Python",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3 :: Only",
+    "Topic :: System :: Shells",
+]
+requires-python = ">=3.10"
+dependencies = [
+    'colorama; sys_platform == "win32"',
+    "decorator",
+    "exceptiongroup; python_version<'3.11'",
+    "jedi>=0.16",
+    "matplotlib-inline",
+    'pexpect>4.3; sys_platform != "win32" and sys_platform != "emscripten"',
+    "prompt_toolkit>=3.0.41,<3.1.0",
+    "pygments>=2.4.0",
+    "stack_data",
+    "traitlets>=5",
+    "typing_extensions; python_version<'3.10'",
+]
+dynamic = ["authors", "entry-points", "license", "scripts", "version"]
+
+[project.readme]
+file = "long_description.rst"
+content-type = "text/x-rst"
+
+[project.urls]
+Homepage = "https://ipython.org"
+Documentation = "https://ipython.readthedocs.io/"
+Funding = "https://numfocus.org/"
+Source = "https://github.com/ipython/ipython"
+Tracker = "https://github.com/ipython/ipython/issues"
+
+[project.optional-dependencies]
+black = [
+    "black",
+]
+doc = [
+    "ipykernel",
+    "setuptools>=18.5",
+    "sphinx>=1.3",
+    "sphinx-rtd-theme",
+    "docrepr",
+    "matplotlib",
+    "stack_data",
+    "typing_extensions",
+    "exceptiongroup",
+    "ipython[test]",
+]
+kernel = [
+    "ipykernel",
+]
+nbconvert = [
+    "nbconvert",
+]
+nbformat = [
+    "nbformat",
+]
+notebook = [
+    "ipywidgets",
+    "notebook",
+]
+parallel = [
+    "ipyparallel",
+]
+qtconsole = [
+    "qtconsole",
+]
+terminal = []
+test = [
+    "pytest<8",
+    "pytest-asyncio<0.22",
+    "testpath",
+    "pickleshare",
+]
+test_extra = [
+    "ipython[test]",
+    "curio",
+    "matplotlib!=3.2.0",
+    "nbformat",
+    "numpy>=1.23",
+    "pandas",
+    "trio",
+]
+all = [
+    "ipython[black,doc,kernel,nbconvert,nbformat,notebook,parallel,qtconsole,terminal]",
+    "ipython[test,test_extra]",
+]
+
 [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/profileapp.py',
    'IPython/lib/deepreload.py',
    'IPython/sphinxext/ipython_directive.py',
    'IPython/terminal/ipapp.py',
    'IPython/utils/_process_win32.py',
    'IPython/utils/path.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"
+
+[tool.setuptools]
+zip-safe = false
+platforms = ["Linux", "Mac OSX", "Windows"]
+license-files = ["LICENSE"]
+include-package-data = false
+
+[tool.setuptools.packages.find]
+exclude = ["setupext"]
+namespaces = false
+
+[tool.setuptools.package-data]
+"IPython" = ["py.typed"]
+"IPython.core" = ["profile/README*"]
+"IPython.core.tests" = ["*.png", "*.jpg", "daft_extension/*.py"]
+"IPython.lib.tests" = ["*.wav"]
+"IPython.testing.plugin" = ["*.txt"]
+
+[tool.setuptools.dynamic]
+version = {attr = "IPython.core.release.__version__"}

setup.cfg

@@ -1,115 +1,7 b''
-[metadata]
-name = ipython
-version = attr: IPython.core.release.__version__
-url = https://ipython.org
-description = IPython: Productive Interactive Computing
-long_description_content_type = text/x-rst
-long_description = file: long_description.rst
-license_file = LICENSE
-project_urls =
-    Documentation = https://ipython.readthedocs.io/
-    Funding = https://numfocus.org/
-    Source = https://github.com/ipython/ipython
-    Tracker = https://github.com/ipython/ipython/issues
-keywords = Interactive, Interpreter, Shell, Embedding
-platforms = Linux, Mac OSX, Windows
-classifiers =
-    Framework :: IPython
-    Framework :: Jupyter
-    Intended Audience :: Developers
-    Intended Audience :: Science/Research
-    License :: OSI Approved :: BSD License
-    Programming Language :: Python
-    Programming Language :: Python :: 3
-    Programming Language :: Python :: 3 :: Only
-    Topic :: System :: Shells
-
-[options]
-packages = find:
-python_requires = >=3.10
-zip_safe = False
-install_requires =
-    colorama; sys_platform == "win32"
-    decorator
-    exceptiongroup; python_version<'3.11'
-    jedi>=0.16
-    matplotlib-inline
-    pexpect>4.3; sys_platform != "win32" and sys_platform != "emscripten"
-    prompt_toolkit>=3.0.41,<3.1.0
-    pygments>=2.4.0
-    stack_data
-    traitlets>=5
-    typing_extensions ; python_version<'3.10'
-
-[options.extras_require]
-black =
-    black
-doc =
-    ipykernel
-    setuptools>=18.5
-    sphinx>=1.3
-    sphinx-rtd-theme
-    docrepr
-    matplotlib
-    stack_data
-    typing_extensions
-    exceptiongroup
-    %(test)s
-kernel =
-    ipykernel
-nbconvert =
-    nbconvert
-nbformat =
-    nbformat
-notebook =
-    ipywidgets
-    notebook
-parallel =
-    ipyparallel
-qtconsole =
-    qtconsole
-terminal =
-test =
-    pytest<8
-    pytest-asyncio<0.22
-    testpath
-    pickleshare
-test_extra =
-    %(test)s
-    curio
-    matplotlib!=3.2.0
-    nbformat
-    numpy>=1.23
-    pandas
-    trio
-all =
-    %(black)s
-    %(doc)s
-    %(kernel)s
-    %(nbconvert)s
-    %(nbformat)s
-    %(notebook)s
-    %(parallel)s
-    %(qtconsole)s
-    %(terminal)s
-    %(test_extra)s
-    %(test)s
-
-[options.packages.find]
-exclude =
-    setupext
-
-[options.package_data]
-IPython = py.typed
-IPython.core = profile/README*
-IPython.core.tests = *.png, *.jpg, daft_extension/*.py
-IPython.lib.tests = *.wav
-IPython.testing.plugin = *.txt
-
 [velin]
 ignore_patterns =
    IPython/core/tests
    IPython/testing
 
 [tool.black]
 exclude = 'timing\.py'

setupbase.py

@@ -1,349 +1,310 b''
 # encoding: utf-8
 """
 This module defines the things that are used in setup.py for building IPython
 
 This includes:
 
     * The basic arguments to setup
     * Functions for finding things like packages, package data, etc.
     * A function for checking dependencies.
 """
 
 # Copyright (c) IPython Development Team.
 # Distributed under the terms of the Modified BSD License.
 
 import os
 import re
 import sys
 from glob import glob
 from logging import log
 
 from setuptools import Command
 from setuptools.command.build_py import build_py
 
 from setuptools.command.install import install
 from setuptools.command.install_scripts import install_scripts
 
 
 #-------------------------------------------------------------------------------
 # Useful globals and utility functions
 #-------------------------------------------------------------------------------
 
 # A few handy globals
 isfile = os.path.isfile
 pjoin = os.path.join
 repo_root = os.path.dirname(os.path.abspath(__file__))
 
 def execfile(fname, globs, locs=None):
     locs = locs or globs
     with open(fname, encoding="utf-8") as f:
         exec(compile(f.read(), fname, "exec"), globs, locs)
 
 # A little utility we'll need below, since glob() does NOT allow you to do
 # exclusion on multiple endings!
 def file_doesnt_endwith(test,endings):
     """Return true if test is a file and its name does NOT end with any
     of the strings listed in endings."""
     if not isfile(test):
         return False
     for e in endings:
         if test.endswith(e):
             return False
     return True
 
 #---------------------------------------------------------------------------
 # Basic project information
 #---------------------------------------------------------------------------
 
 # release.py contains version, authors, license, url, keywords, etc.
 execfile(pjoin(repo_root, 'IPython','core','release.py'), globals())
 
 # Create a dict with the basic information
 # This dict is eventually passed to setup after additional keys are added.
 setup_args = dict(
       author           = author,
       author_email     = author_email,
       license          = license,
       )
 
-
-#---------------------------------------------------------------------------
-# Find packages
-#---------------------------------------------------------------------------
-
-def find_packages():
-    """
-    Find all of IPython's packages.
-    """
-    excludes = ['deathrow', 'quarantine']
-    packages = []
-    for directory, subdirs, files in os.walk("IPython"):
-        package = directory.replace(os.path.sep, ".")
-        if any(package.startswith("IPython." + exc) for exc in excludes):
-            # package is to be excluded (e.g. deathrow)
-            continue
-        if '__init__.py' not in files:
-            # not a package
-            continue
-        packages.append(package)
-    return packages
-
 #---------------------------------------------------------------------------
-# Find package data
+# Check package data
 #---------------------------------------------------------------------------
 
-def find_package_data():
-    """
-    Find IPython's package_data.
-    """
-    # This is not enough for these things to appear in an sdist.
-    # We need to muck with the MANIFEST to get this to work
-
-    package_data = {
-        'IPython.core' : ['profile/README*'],
-        'IPython.core.tests' : ['*.png', '*.jpg', 'daft_extension/*.py'],
-        'IPython.lib.tests' : ['*.wav'],
-        'IPython.testing.plugin' : ['*.txt'],
-    }
-
-    return package_data
-
-
 def check_package_data(package_data):
     """verify that package_data globs make sense"""
     print("checking package data")
     for pkg, data in package_data.items():
         pkg_root = pjoin(*pkg.split('.'))
         for d in data:
             path = pjoin(pkg_root, d)
             if '*' in path:
                 assert len(glob(path)) > 0, "No files match pattern %s" % path
             else:
                 assert os.path.exists(path), "Missing package data: %s" % path
 
 
 def check_package_data_first(command):
     """decorator for checking package_data before running a given command
 
     Probably only needs to wrap build_py
     """
     class DecoratedCommand(command):
         def run(self):
             check_package_data(self.package_data)
             command.run(self)
     return DecoratedCommand
 
 
 #---------------------------------------------------------------------------
 # Find data files
 #---------------------------------------------------------------------------
 
 def find_data_files():
     """
     Find IPython's data_files.
 
     Just man pages at this point.
     """
 
     if "freebsd" in sys.platform:
         manpagebase = pjoin('man', 'man1')
     else:
         manpagebase = pjoin('share', 'man', 'man1')
 
     # Simple file lists can be made by hand
     manpages = [f for f in glob(pjoin('docs','man','*.1.gz')) if isfile(f)]
     if not manpages:
         # When running from a source tree, the manpages aren't gzipped
         manpages = [f for f in glob(pjoin('docs','man','*.1')) if isfile(f)]
 
     # And assemble the entire output list
     data_files = [ (manpagebase, manpages) ]
 
     return data_files
 
 
 # The two functions below are copied from IPython.utils.path, so we don't need
 # to import IPython during setup, which fails on Python 3.
 
 def target_outdated(target,deps):
     """Determine whether a target is out of date.
 
     target_outdated(target,deps) -> 1/0
 
     deps: list of filenames which MUST exist.
     target: single filename which may or may not exist.
 
     If target doesn't exist or is older than any file listed in deps, return
     true, otherwise return false.
     """
     try:
         target_time = os.path.getmtime(target)
     except os.error:
         return 1
     for dep in deps:
         dep_time = os.path.getmtime(dep)
         if dep_time > target_time:
             #print "For target",target,"Dep failed:",dep # dbg
             #print "times (dep,tar):",dep_time,target_time # dbg
             return 1
     return 0
 
 
 def target_update(target,deps,cmd):
     """Update a target with a given command given a list of dependencies.
 
     target_update(target,deps,cmd) -> runs cmd if target is outdated.
 
     This is just a wrapper around target_outdated() which calls the given
     command if target is outdated."""
 
     if target_outdated(target,deps):
         os.system(cmd)
 
 #---------------------------------------------------------------------------
 # Find scripts
 #---------------------------------------------------------------------------
 
 def find_entry_points():
     """Defines the command line entry points for IPython
 
     This always uses setuptools-style entry points. When setuptools is not in
     use, our own build_scripts_entrypt class below parses these and builds
     command line scripts.
 
     Each of our entry points gets a plain name, e.g. ipython, and a name
     suffixed with the Python major version number, e.g. ipython3.
     """
     ep = [
             'ipython%s = IPython:start_ipython',
         ]
     major_suffix = str(sys.version_info[0])
     return [e % "" for e in ep] + [e % major_suffix for e in ep]
 
 
 class install_lib_symlink(Command):
     user_options = [
         ('install-dir=', 'd', "directory to install to"),
         ]
 
     def initialize_options(self):
         self.install_dir = None
 
     def finalize_options(self):
         self.set_undefined_options('symlink',
                                    ('install_lib', 'install_dir'),
                                   )
 
     def run(self):
         if sys.platform == 'win32':
             raise Exception("This doesn't work on Windows.")
         pkg = os.path.join(os.getcwd(), 'IPython')
         dest = os.path.join(self.install_dir, 'IPython')
         if os.path.islink(dest):
             print('removing existing symlink at %s' % dest)
             os.unlink(dest)
         print('symlinking %s -> %s' % (pkg, dest))
         os.symlink(pkg, dest)
 
 class unsymlink(install):
     def run(self):
         dest = os.path.join(self.install_lib, 'IPython')
         if os.path.islink(dest):
             print('removing symlink at %s' % dest)
             os.unlink(dest)
         else:
             print('No symlink exists at %s' % dest)
 
 class install_symlinked(install):
     def run(self):
         if sys.platform == 'win32':
             raise Exception("This doesn't work on Windows.")
 
         # Run all sub-commands (at least those that need to be run)
         for cmd_name in self.get_sub_commands():
             self.run_command(cmd_name)
 
     # 'sub_commands': a list of commands this command might have to run to
     # get its work done.  See cmd.py for more info.
     sub_commands = [('install_lib_symlink', lambda self:True),
                     ('install_scripts_sym', lambda self:True),
                    ]
 
 class install_scripts_for_symlink(install_scripts):
     """Redefined to get options from 'symlink' instead of 'install'.
 
     I love distutils almost as much as I love setuptools.
     """
     def finalize_options(self):
         self.set_undefined_options('build', ('build_scripts', 'build_dir'))
         self.set_undefined_options('symlink',
                                    ('install_scripts', 'install_dir'),
                                    ('force', 'force'),
                                    ('skip_build', 'skip_build'),
                                   )
 
 
 #---------------------------------------------------------------------------
 # VCS related
 #---------------------------------------------------------------------------
 
 
 def git_prebuild(pkg_dir, build_cmd=build_py):
     """Return extended build or sdist command class for recording commit
 
     records git commit in IPython.utils._sysinfo.commit
 
     for use in IPython.utils.sysinfo.sys_info() calls after installation.
     """
 
     class MyBuildPy(build_cmd):
         ''' Subclass to write commit data into installation tree '''
         def run(self):
             # loose as `.dev` is suppose to be invalid
             print("check version number")
             loose_pep440re = re.compile(r'^(\d+)\.(\d+)\.(\d+((a|b|rc)\d+)?)(\.post\d+)?(\.dev\d*)?$')
             if not loose_pep440re.match(version):
                 raise ValueError("Version number '%s' is not valid (should match [N!]N(.N)*[{a|b|rc}N][.postN][.devN])" % version)
 
 
             build_cmd.run(self)
             # this one will only fire for build commands
             if hasattr(self, 'build_lib'):
                 self._record_commit(self.build_lib)
 
         def make_release_tree(self, base_dir, files):
             # this one will fire for sdist
             build_cmd.make_release_tree(self, base_dir, files)
             self._record_commit(base_dir)
 
         def _record_commit(self, base_dir):
             import subprocess
             proc = subprocess.Popen('git rev-parse --short HEAD',
                                     stdout=subprocess.PIPE,
                                     stderr=subprocess.PIPE,
                                     shell=True)
             repo_commit, _ = proc.communicate()
             repo_commit = repo_commit.strip().decode("ascii")
 
             out_pth = pjoin(base_dir, pkg_dir, 'utils', '_sysinfo.py')
             if os.path.isfile(out_pth) and not repo_commit:
                 # nothing to write, don't clobber
                 return
 
             print("writing git commit '%s' to %s" % (repo_commit, out_pth))
 
             # remove to avoid overwriting original via hard link
             try:
                 os.remove(out_pth)
             except (IOError, OSError):
                 pass
             with open(out_pth, "w", encoding="utf-8") as out_file:
                 out_file.writelines(
                     [
                         "# GENERATED BY setup.py\n",
                         'commit = "%s"\n' % repo_commit,
                     ]
                 )
 
     return MyBuildPy