Scripting

Module called for configuring, compiling and installing targets

waflib.Scripting.waf_entry_point(current_directory, version, wafdir)

This is the main entry point, all Waf execution starts here.

Parameters:

• current_directory (string) – absolute path representing the current directory
• version (string) – version number
• wafdir (string) – absolute path representing the directory of the waf library

waflib.Scripting.set_main_module(file_path)

Read the main wscript file into waflib.Context.Context.g_module and bind default functions such as init, dist, distclean if not defined. Called by waflib.Scripting.waf_entry_point() during the initialization.

Parameters:file_path (string) – absolute path representing the top-level wscript file

waflib.Scripting.parse_options()

Parse the command-line options and initialize the logging system. Called by waflib.Scripting.waf_entry_point() during the initialization.

waflib.Scripting.run_command(cmd_name)

Execute a single command. Called by waflib.Scripting.run_commands().

Parameters:cmd_name (string) – command to execute, like build

waflib.Scripting.run_commands()

Execute the commands that were given on the command-line, and the other options Called by waflib.Scripting.waf_entry_point() during the initialization, and executed after waflib.Scripting.parse_options().

waflib.Scripting.distclean_dir(dirname)

Distclean function called in the particular case when:

top == out

Parameters:dirname (string) – absolute path of the folder to clean

waflib.Scripting.distclean(ctx)

removes the build directory

class waflib.Scripting.Dist(**kw)

Bases: waflib.Context.Context

creates an archive containing the project source code

cmd = 'dist'

fun = 'dist'

algo = 'tar.bz2'

ext_algo = {}

execute()

See waflib.Context.Context.execute()

archive()

Create the archive.

get_tar_path(node)

return the path to use for a node in the tar archive, the purpose of this is to let subclases resolve symbolic links or to change file names

add_tar_file(x, tar)

Add a file to the tar archive. Transform symlinks into files if the files lie out of the project tree.

get_arch_name()

Return the name of the archive to create. Change the default value by setting arch_name:

def dist(ctx):
        ctx.arch_name = 'ctx.tar.bz2'

Return type:string

get_base_name()

Return the default name of the main directory in the archive, which is set to appname-version. Set the attribute base_name to change the default value:

def dist(ctx):
        ctx.base_name = 'files'

Return type:string

get_excl()

Return the patterns to exclude for finding the files in the top-level directory. Set the attribute excl to change the default value:

def dist(ctx):
        ctx.excl = 'build **/*.o **/*.class'

Return type:string

get_files()

The files to package are searched automatically by waflib.Node.Node.ant_glob(). Set files to prevent this behaviour:

def dist(ctx):
        ctx.files = ctx.path.find_node('wscript')

The files are searched from the directory ‘base_path’, to change it, set:

def dist(ctx):
        ctx.base_path = path

Return type:list of waflib.Node.Node

__doc__ = 'creates an archive containing the project source code'

__module__ = 'waflib.Scripting'

waflib.Scripting.dist(ctx)

makes a tarball for redistributing the sources

class waflib.Scripting.DistCheck(**kw)

Bases: waflib.Scripting.Dist

Create an archive of the project, and try to build the project in a temporary directory:

$ waf distcheck

fun = 'distcheck'

cmd = 'distcheck'

execute()

See waflib.Context.Context.execute()

check()

Create the archive, uncompress it and try to build the project

__doc__ = '\n\tCreate an archive of the project, and try to build the project in a temporary directory::\n\n\t\t$ waf distcheck\n\t'

__module__ = 'waflib.Scripting'

waflib.Scripting.distcheck(ctx)

checks if the project compiles (tarball from ‘dist’)

waflib.Scripting.autoconfigure(execute_method)

Decorator used to set the commands that can be configured automatically