20.3. Using scanners with Builders

One approach for introducing a Scanner into the build is in conjunction with a Builder. There are two relvant optional parameters we can use when creating a Builder: source_scanner and target_scanner. source_scanner is used for scanning source files, and target_scanner is used for scanning the target once it is generated.

import re

include_re = re.compile(r'^include\s+(\S+)$', re.M)

def kfile_scan(node, env, path, arg):
    contents = node.get_text_contents()
    return env.File(include_re.findall(contents))

kscan = Scanner(function=kfile_scan, skeys=['.k'], path_function=FindPathDirs('KPATH')

def build_function(target, source, env):
    # Code to build "target" from "source"
    return None

bld = Builder(
env = Environment(BUILDERS={'Foo': bld})

An emitter function can modify the list of sources or targets passed to the action function when the Builder is triggered.

A scanner function will not affect the list of sources or targets seen by the Builder during the build action. The scanner function will however affect if the Builder should rebuild (if any of the files sourced by the Scanner have changed for example).