pybind11.setup_helpers.ParallelCompile Class Reference

Public Member Functions
def	__enter__
def	__exit__
def	__init__
def	function (self)
def	install

Static Public Attributes
	default
	envvar
	max
	needs_recompile

Static Private Attributes
	__slots__

Detailed Description

Make a parallel compile function. Inspired by
numpy.distutils.ccompiler.CCompiler.compile and cppimport.

This takes several arguments that allow you to customize the compile
function created:

envvar:
    Set an environment variable to control the compilation threads, like
    NPY_NUM_BUILD_JOBS
default:
    0 will automatically multithread, or 1 will only multithread if the
    envvar is set.
max:
    The limit for automatic multithreading if non-zero
needs_recompile:
    A function of (obj, src) that returns True when recompile is needed.  No
    effect in isolated mode; use ccache instead, see
    https://github.com/matplotlib/matplotlib/issues/1507/

To use::

    ParallelCompile("NPY_NUM_BUILD_JOBS").install()

or::

    with ParallelCompile("NPY_NUM_BUILD_JOBS"):
        setup(...)

By default, this assumes all files need to be recompiled. A smarter
function can be provided via needs_recompile.  If the output has not yet
been generated, the compile will always run, and this function is not
called.

Definition at line 375 of file setup_helpers.py.

Constructor & Destructor Documentation

__init__()

def pybind11.setup_helpers.ParallelCompile.__init__	(		self,
			envvar
	)

Definition at line 415 of file setup_helpers.py.

Member Function Documentation

__enter__()

def pybind11.setup_helpers.ParallelCompile.__enter__

(

self

)

Definition at line 499 of file setup_helpers.py.

__exit__()

def pybind11.setup_helpers.ParallelCompile.__exit__	(		self,
			args
	)

Definition at line 503 of file setup_helpers.py.

function()

def pybind11.setup_helpers.ParallelCompile.function	(		self,
			CCompilerMethod
	)

Builds a function object usable as distutils.ccompiler.CCompiler.compile.

Definition at line 426 of file setup_helpers.py.

install()

def pybind11.setup_helpers.ParallelCompile.install

(

self

)

Definition at line 492 of file setup_helpers.py.

Member Data Documentation

__slots__

pybind11.setup_helpers.ParallelCompile.__slots__

staticprivate

Definition at line 411 of file setup_helpers.py.

default

pybind11.setup_helpers.ParallelCompile.default

static

Definition at line 421 of file setup_helpers.py.

envvar

pybind11.setup_helpers.ParallelCompile.envvar

static

Definition at line 420 of file setup_helpers.py.

max

pybind11.setup_helpers.ParallelCompile.max

static

Definition at line 422 of file setup_helpers.py.

needs_recompile

pybind11.setup_helpers.ParallelCompile.needs_recompile

static

Definition at line 423 of file setup_helpers.py.

---

The documentation for this class was generated from the following file:

• setup_helpers.py