wtools.project Namespace Reference

Classes
class	TestContext
class	DocsContext
class	LintContext

Functions
def	create_project_lmod
def	create_project_gdbinit
def	default_configure
	Returns the default implementation of the configure command. More...
def	wtools_showversion
def	default_options
	Default implementation of options in the top level waf script. More...
def	default_init
	Default implementation of init. More...
def	default_build
	Default implementation of build command. More...
def	check_env
	Check presence of environment variable env. More...
def	declare_project
	Declares a top level waf project. More...

Variables
list	__all__ = ['init', 'build', 'test',]
string	name = ''
string	version = ''
	LMOD_TEMPLATE = \
	GDBINIT_TEMPLATE = \

Function Documentation

def wtools.project.check_env	(		self,
			env,
			predicate = None
	)

Check presence of environment variable env.

Parameters

env	Name of environment variable to test presence for.
predicate	Predicate used to perform additional test(s). Signature (status, error) = predicate(value) where 'status' is False for failed test, True otherwise and 'error' is an error description to the user.

Examples

def configure(ctx): ctx.check_env('FOO')

def wtools.project.create_project_gdbinit

(

task

)

def wtools.project.create_project_lmod

(

task

)

def wtools.project.declare_project	(		name,
			version,
			recurse,
			requires,
			kwargs
	)

Declares a top level waf project.

Parameters

name	Project name

Version

: Version string

Parameters

recurse	Glob-patterns of directories to recurse into.
requires	A string list of project requirements (c.f. wtools.config.Requires).
boost_libs	string list of boost libraries to include. E.g. 'program_options filesystem'

def wtools.project.default_build	(		bld,
			recurse
	)

Default implementation of build command.

def wtools.project.default_configure	(		cnf,
			recurse,
			orig,
			requires,
			wtools_dir,
			kwargs
	)

Returns the default implementation of the configure command.

def wtools.project.default_init	(		ctx,
			wtools_dir
	)

Default implementation of init.

def wtools.project.default_options	(		opt,
			recurse,
			requires,
			wtools_dir,
			kwargs
	)

Default implementation of options in the top level waf script.

def wtools.project.wtools_showversion	(		option,
			opt,
			value,
			parser
	)

Variable Documentation

list wtools.project.__all__ = ['init', 'build', 'test',]

wtools.project.GDBINIT_TEMPLATE = \

wtools.project.LMOD_TEMPLATE = \

string wtools.project.name = ''

string wtools.project.version = ''