SCons API 4.4官方文档：模块与平台详解

需积分: 10 140 浏览量更新于2024-06-30 收藏 4.82MB PDF 举报

SCons API 手册文档（version 4.4）是SCons项目的重要参考资料，它详细介绍了SCons构建工具的核心组件、模块和平台特定支持。SCons是一个强大的、基于Python的构建系统，用于自动化软件开发过程中的编译、链接和部署任务。本文档涵盖的主要部分包括： 1. **SConsProject**：文档的主体部分首先介绍了SCons项目的总体结构，概述了其作为构建工具的基本功能和设计理念。 2. **SConspackage**：这个模块包含SCons的核心功能，如节点（Node）管理，它们是构建过程中的基本元素，如源文件、目标文件等。模块下有子模块： - **SCons.Node.Aliasmodule**：处理构建任务的别名和依赖关系。 - **SCons.Node.FSmodule**：提供与文件系统交互的功能，如创建、读取和删除文件。 - **SCons.Node.Pythonmodule**：与Python相关的节点管理，可能涉及到Python源代码的处理。 3. **SCons.Platformpackage**：这部分涵盖了针对不同操作系统的平台适配模块，如AIX、Cygwin、Darwin (macOS)、HP-UX、IRIX、MinGW (Windows上的GCC)、OS/2、POSIX兼容系统、SunOS、Virtualenv以及Win32（Windows）。每个模块都负责特定平台上的构建细节，如路径处理、工具链配置等。 4. **SCons.Scannerpackage**：扫描器模块负责检测源文件类型，如C/C++、D、目录、Fortran、IDL、LaTeX、程序脚本、资源文件（如RC文件）和SWIG接口文件。这些模块确保构建系统能够正确识别和处理各种类型的源代码。 5. **SCons.Scriptpackage**：这个子模块可能包含编写SCons构建脚本的工具和函数，帮助用户定义构建规则和任务。整个文档提供了丰富的API参考，让开发者可以深入理解如何利用SCons的模块化设计来定制和扩展构建流程，以适应各种开发环境和需求。阅读和掌握这个文档对于熟练使用SCons进行项目构建至关重要。

__len__ and __bool__ attributes on instances of our Builder Proxy class(es), generating a bazillion extra calls and

slowing things down immensely.

must_be_same (klass)

This node, which already existed, is being looked up as the specified klass. Raise an exception if it isn’t.

name

new_binfo ()

new_ninfo ()

ninfo

nocache

noclean

postprocess ()

Clean up anything we don’t need to hang onto after we’ve been built.

precious

prepare ()

Prepare for this Node to be built.

This is called after the Taskmaster has decided that the Node is out-of-date and must be rebuilt, but before actually

calling the method to build the Node.

This default implementation checks that explicit or implicit dependencies either exist or are derived, and initializes

the BuildInfo structure that will hold the information about how this node is, uh, built.

(The existence of source files is checked separately by the Executor, which aggregates checks for all of the targets

built by a specific action.)

Overriding this method allows for for a Node subclass to remove the underlying file from the file system. Note that

subclass methods should call this base class method to get the child check and the BuildInfo structure.

prerequisites

pseudo

push_to_cache ()

Try to push a node into a cache

ref_count

release_target_info ()

Called just after this node has been marked up-to-date or was built completely.

This is where we try to release as many target node infos as possible for clean builds and update runs, in order to

minimize the overall memory consumption.

By purging attributes that aren’t needed any longer after a Node (=File) got built, we don’t have to care that much

how many KBytes a Node actually requires…as long as we free the memory shortly afterwards.

@see: built() and File.release_target_info()

remove ()

Remove this Node: no-op by default.

render_include_tree ()

Return a text representation, suitable for displaying to the user, of the include tree for the sources of this node.

rentry ()

reset_executor ()

Remove cached executor; forces recompute when needed.

retrieve_from_cache ()

Try to retrieve the node’s content from a cache

This method is called from multiple threads in a parallel build, so only do thread safe stuff here. Do thread unsafe

stuff in built().

Returns true if the node was successfully retrieved.

rexists ()

Does this node exist locally or in a repository?

rfile ()

rstr ()

A Node.FS.Base object’s string representation is its path name.

sbuilder

scan ()

Scan this node’s dependents for implicit dependencies.

scanner_key ()

SCons Project API Documentation

Looks up or creates a directory node named ‘name’ relative to this directory.

Entry (name)

Looks up or creates an entry node named ‘name’ relative to this directory.

File (name)

Looks up or creates a file node named ‘name’ relative to this directory.

GetTag (key)

Return a user-defined tag.

NodeInfo

alias of DirNodeInfo

RDirs (pathlist)

Search for a list of directories in the Repository list.

Rfindalldirs (pathlist)

Return all of the directories for a given path list, including corresponding “backing” directories in any repositories.

The Node lookups are relative to this Node (typically a directory), so memoizing result saves cycles from looking up

the same path for each target in a given directory.

Tag (key, value)

Add a user-defined tag.

_Rfindalldirs_key (pathlist)

__clearRepositoryCache (duplicate=None)

Called when we change the repository(ies) for a directory. This clears any cached information that is invalidated by

changing the repository.

__resetDuplicate (node)

_abspath

_add_child (collection, set, child)

Adds ‘child’ to ‘collection’, first checking ‘set’ to see if it’s already present.

_children_get ()

_children_reset ()

_create ()

Create this directory, silently and without worrying about whether the builder is the default or not.

_func_exists

_func_get_contents

_func_is_derived

_func_rexists

_func_sconsign

_func_target_from_source

_get_scanner (env, initial_scanner, root_node_scanner, kw)

_get_str ()

_glob1 (pattern, ondisk=True, source=False, strings=False)

Globs for and returns a list of entry names matching a single pattern in this directory.

This searches any repositories and source directories for corresponding entries and returns a Node (or string)

relative to the current directory if an entry is found anywhere.

TODO: handle pattern with no wildcard

_labspath

_local

_memo

_morph ()

Turn a file system Node (either a freshly initialized directory object or a separate Entry object) into a proper

directory object.

Set up this directory’s entries and hook it into the file system tree. Specify that directories (this Node) don’t use

signatures for calculating whether they’re current.

_path

_path_elements

_proxy

_rel_path_key (other)

_save_str ()

_sconsign

SCons Project API Documentation

_specific_sources

_srcdir_find_file_key (filename)

_tags

_tpath

addRepository (dir)

add_dependency (depend)

Adds dependencies.

add_ignore (depend)

Adds dependencies to ignore.

add_prerequisite (prerequisite)

Adds prerequisites

add_source (source)

Adds sources.

add_to_implicit (deps)

add_to_waiting_parents (node)

Returns the number of nodes added to our waiting parents list: 1 if we add a unique waiting parent, 0 if not. (Note

that the returned values are intended to be used to increment a reference count, so don’t think you can “clean up”

this function by using True and False instead…)

add_to_waiting_s_e (node)

add_wkid (wkid)

Add a node to the list of kids waiting to be evaluated

all_children (scan=1)

Return a list of all the node’s direct children.

alter_targets ()

Return any corresponding targets in a variant directory.

always_build

attributes

binfo

build (**kw)

A null “builder” for directories.

builder

builder_set (builder)

built ()

Called just after this node is successfully built.

cached

cachedir_csig

cachesig

changed (node=None, allowcache=False)

Returns if the node is up-to-date with respect to the BuildInfo stored last time it was built. The default behavior is to

compare it against our own previously stored BuildInfo, but the stored BuildInfo from another Node (typically one in

a Repository) can be used instead.

Note that we now always check every dependency. We used to short-circuit the check by returning as soon as we

detected any difference, but we now rely on checking every dependency to make sure that any necessary Node

information (for example, the content signature of an #included .h file) is updated.

The allowcache option was added for supporting the early release of the executor/builder structures, right after a

File target was built. When set to true, the return value of this changed method gets cached for File nodes. Like

this, the executor isn’t needed any longer for subsequent calls to changed().

@see: FS.File.changed(), FS.File.release_target_info()

changed_since_last_build

check_attributes (name)

Simple API to check if the node.attributes for name has been set

children (scan=1)

Return a list of the node’s direct children, minus those that are ignored by this node.

children_are_up_to_date ()

Alternate check for whether the Node is current: If all of our children were up-to-date, then this Node was

up-to-date, too.

SCons Project API Documentation

The SCons.Node.Alias and SCons.Node.Python.Value subclasses rebind their current() method to this method.

clear ()

Completely clear a Node of all its cached state (so that it can be re-evaluated by interfaces that do continuous

integration builds).

clear_memoized_values ()

contentsig

cwd

del_binfo ()

Delete the build info from this node.

depends

depends_set

dir

dir_on_disk (name)

dirname

disambiguate (must_exist=None)

diskcheck_match ()

do_duplicate (src)

duplicate

entries

entry_abspath (name)

entry_exists_on_disk (name)

Searches through the file/dir entries of the current directory, and returns True if a physical entry with the given

name could be found.

@see rentry_exists_on_disk

entry_labspath (name)

entry_path (name)

entry_tpath (name)

env

env_set (env, safe=0)

executor

executor_cleanup ()

Let the executor clean up any cached information.

exists ()

Does this node exists?

explain ()

file_on_disk (name)

for_signature ()

Return a string representation of the Node that will always be the same for this particular Node, no matter what.

This is by contrast to the __str__() method, which might, for instance, return a relative path for a file Node. The

purpose of this method is to generate a value to be used in signature calculation for the command line used to

build a target, and we use this method instead of str() to avoid unnecessary rebuilds. This method does not need to

return something that would actually work in a command line; it can return any kind of nonsense, so long as it does

not change.

Reference to parent Node.FS object

getRepositories ()

Returns a list of repositories for this directory.

get_abspath () → str

Get the absolute path of the file.

get_all_rdirs ()

get_binfo ()

Fetch a node’s build information.

node - the node whose sources will be collected cache - alternate node to use for the signature cache returns - the

build signature

This no longer handles the recursive descent of the node’s children’s signatures. We expect that they’re already

built and updated by someone else, if that’s what’s wanted.

SCons Project API Documentation

剩余336页未读，继续阅读

arbotor

粉丝: 0
资源: 5

SCons API 4.4官方文档：模块与平台详解

Scons使用手册

scons用户手册

scons 用户使用手册

scons脚本文档

scons 2.4.0 用户指南

SCons 3.0.1: Agg库与Mapnik Python绑定教程

AWTK开发实践：绿盟远程安全评估系统用户手册

scons 帮助手册 pdf(全)

scons用户手册（英文）

scons使用设计手册

最新资源