Skip to content

Commit

Permalink
Fix setup.py detail headers and add pip install tests to Travis
Browse files Browse the repository at this point in the history
The default `install_headers` from `distutils` flattens all the headers
into a single directory -- `detail` subdirectory was lost. This commit
fixes this by overriding the setup with a custom header installer.

Tests are added to Travis to make sure `setup.py sdist` and `pip install`
do not miss any headers and that the directory structure is preserved.

[skip appveyor]
  • Loading branch information
dean0x7d committed Aug 24, 2017
1 parent e8b5074 commit 1913f25
Show file tree
Hide file tree
Showing 3 changed files with 28 additions and 3 deletions.
9 changes: 8 additions & 1 deletion .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,8 @@ matrix:
# Documentation build:
- os: linux
language: docs
env: DOCS STYLE LINT
env: DOCS STYLE LINT PIP
cache: false
install:
- export PATH="~/.local/bin:$PATH"
- $PY_CMD -m pip install --user --upgrade sphinx sphinx_rtd_theme breathe flake8 pep8-naming
Expand All @@ -76,6 +77,12 @@ matrix:
- $PY_CMD -m sphinx -W -b html docs docs/.build
- tools/check-style.sh
- flake8
- |
# Make sure setup.py distributes and installs all the headers
$PY_CMD setup.py sdist
$PY_CMD -m pip install --user -U ./dist/*
installed=$($PY_CMD -c "import pybind11; print(pybind11.get_include(True) + '/pybind11')")
diff -rq $installed ./include/pybind11
cache:
directories:
- $HOME/.local/bin
Expand Down
2 changes: 1 addition & 1 deletion MANIFEST.in
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
include include/pybind11/*.h
recursive-include include/pybind11 *.h
include LICENSE README.md CONTRIBUTING.md
20 changes: 19 additions & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
# Setup script for PyPI; use CMakeFile.txt to build extension modules

from setuptools import setup
from distutils.command.install_headers import install_headers
from pybind11 import __version__
import os

Expand All @@ -17,7 +18,7 @@
'include/pybind11/detail/descr.h',
'include/pybind11/detail/init.h',
'include/pybind11/detail/internals.h',
'include/pybind11/detail/typeid.h'
'include/pybind11/detail/typeid.h',
'include/pybind11/attr.h',
'include/pybind11/buffer_info.h',
'include/pybind11/cast.h',
Expand All @@ -36,6 +37,22 @@
'include/pybind11/stl_bind.h',
]


class InstallHeaders(install_headers):
"""Use custom header installer because the default one flattens subdirectories"""
def run(self):
if not self.distribution.headers:
return

for header in self.distribution.headers:
subdir = os.path.dirname(os.path.relpath(header, 'include/pybind11'))
install_dir = os.path.join(self.install_dir, subdir)
self.mkpath(install_dir)

(out, _) = self.copy_file(header, install_dir)
self.outfiles.append(out)


setup(
name='pybind11',
version=__version__,
Expand All @@ -47,6 +64,7 @@
packages=['pybind11'],
license='BSD',
headers=headers,
cmdclass=dict(install_headers=InstallHeaders),
classifiers=[
'Development Status :: 5 - Production/Stable',
'Intended Audience :: Developers',
Expand Down

0 comments on commit 1913f25

Please sign in to comment.