Classes
class	build_ext

class	ParallelCompile

class	Pybind11Extension

Functions
str\|int	auto_cpp_level (Any compiler)

bool	has_flag (Any compiler, str flag)

list[Pybind11Extension]	intree_extensions (Iterable[str] paths, dict[str, str]\|None package_dir=None)

bool	naive_recompile (str obj, str src)

bool	no_recompile (str obg, str src)

Iterator[str]	tmp_chdir ()

Variables
	bound

	CCompilerMethod

	cpp_flag_cache

	MACOS

	S

	STD_TMPL

	tmp_chdir_lock

	WIN

Detailed Description

This module provides helpers for C++11+ projects using pybind11.

LICENSE:

Copyright (c) 2016 Wenzel Jakob <wenzel.jakob@epfl.ch>, All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice, this
   list of conditions and the following disclaimer.

2. Redistributions in binary form must reproduce the above copyright notice,
   this list of conditions and the following disclaimer in the documentation
   and/or other materials provided with the distribution.

3. Neither the name of the copyright holder nor the names of its contributors
   may be used to endorse or promote products derived from this software
   without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Function Documentation

◆ auto_cpp_level()

str | int pybind11.setup_helpers.auto_cpp_level ( Any compiler )

Return the max supported C++ std level (17, 14, or 11). Returns latest on Windows.

Definition at line 253 of file setup_helpers.py.

◆ has_flag()

bool pybind11.setup_helpers.has_flag	(	Any	compiler,
		str	flag
	)

Return the flag if a flag name is supported on the
specified compiler, otherwise None (can be used as a boolean).
If multiple flags are passed, return the first that matches.

Definition at line 229 of file setup_helpers.py.

◆ intree_extensions()

list[Pybind11Extension] pybind11.setup_helpers.intree_extensions	(	Iterable[str]	paths,
		dict[str, str] \| None	package_dir = `None`
	)

Generate Pybind11Extensions from source files directly located in a Python
source tree.

``package_dir`` behaves as in ``setuptools.setup``.  If unset, the Python
package root parent is determined as the first parent directory that does
not contain an ``__init__.py`` file.

Definition at line 290 of file setup_helpers.py.

◆ naive_recompile()

bool pybind11.setup_helpers.naive_recompile	(	str	obj,
		str	src
	)

This will recompile only if the source file changes. It does not check
header files, so a more advanced function or Ccache is better if you have
editable header files in your package.

Definition at line 332 of file setup_helpers.py.

◆ no_recompile()

bool pybind11.setup_helpers.no_recompile	(	str	obg,
		str	src
	)

This is the safest but slowest choice (and is the default) - will always
recompile sources.

Definition at line 341 of file setup_helpers.py.

◆ tmp_chdir()

Iterator[str] pybind11.setup_helpers.tmp_chdir ( )

Definition at line 213 of file setup_helpers.py.

Variable Documentation

◆ bound

pybind11.setup_helpers.bound

Definition at line 349 of file setup_helpers.py.

◆ CCompilerMethod

pybind11.setup_helpers.CCompilerMethod

Definition at line 351 of file setup_helpers.py.

◆ cpp_flag_cache

pybind11.setup_helpers.cpp_flag_cache

Definition at line 249 of file setup_helpers.py.

◆ MACOS

pybind11.setup_helpers.MACOS

Definition at line 78 of file setup_helpers.py.

◆ S

pybind11.setup_helpers.S

Definition at line 349 of file setup_helpers.py.

◆ STD_TMPL

pybind11.setup_helpers.STD_TMPL

Definition at line 79 of file setup_helpers.py.

◆ tmp_chdir_lock

pybind11.setup_helpers.tmp_chdir_lock

Definition at line 209 of file setup_helpers.py.

◆ WIN

pybind11.setup_helpers.WIN

Definition at line 77 of file setup_helpers.py.

Classes

Functions

Variables