SCons中文指南：Python脚本驱动的构建工具详解

需积分: 1 53 浏览量更新于2024-06-30 1 收藏 7.49MB PDF 举报

SCons是一款独特的构建工具，其配置文件是使用Python编程语言编写的，这区别于许多其他构建工具，如它们通常采用专用的配置语言。SCons的设计理念使得配置过程更加灵活，因为开发者无需学习新的语言，而是利用他们已经熟悉的Python知识。尽管如此，初次使用SCons可能会有一个学习曲线，因为用户需要了解如何调用适当的函数来设定构建过程。在SCons的4.4.0用户指南中，详细介绍了如何在不同系统上安装和使用SCons。首先，章节1.1介绍了如何安装基础的Python环境（蟒蛇），接着1.2和1.3部分分别涵盖了安装SCons本身、并行构建不同版本、以及在无管理员权限环境下安装的情况。对于初学者，章节2.1到2.6提供了一步步的教程，包括构建C/C++程序、Java项目、清理构建后的产物、理解和使用`.SConstruct`文件（SCons命令行文件，其实质是Python脚本）、控制输出信息等。进入更复杂的构建需求，章节3.1至3.8讨论了指定目标文件名、处理多源文件、使用Glob函数、处理文件列表的读取和格式化、理解关键字参数、构建和链接多个程序以及共享源文件。构建和链接库是另一个核心话题，4.1节详细讲解了如何构建库，区分源代码和对象文件，以及静态库和共享库的生成。章节5.1至5.5深入探讨了节点对象的概念，如生成器方法、节点的创建和操作、以及获取构建路径的方法。依赖关系管理是SCons的重要组成部分，6.1章节介绍了决策器函数，包括内容签名、时间戳、MD5签名和自定义函数的使用，以及如何混合不同的决定机制，确保当输入文件发生变化时，构建能够自动进行更新。 SCons用户指南提供了从基础安装到高级构建技巧的全面指导，特别强调了其Python集成的优势，帮助开发者高效地管理和控制软件构建过程。通过这个指南，用户可以掌握如何利用SCons的灵活性和功能，提升构建效率和项目管理。

2022/10/8 23:29

图标 4.4.0

https://scons.org/doc/production/HTML/scons-user.html

16/179

import os.path

program_list = Program('hello.c')

program_name = str(program_list[0])

if not os.path.exists(program_name):

print("%s does not exist!"%program_name)

它在 POSIX 系统上按如下方式执行：

% scons -Q

hello does not exist!

cc -o hello.o -c hello.c

cc -o hello hello.o

5.5. 获取构建路径：从节点或字符串获取路径

环境。获取构建路径（file_or_list）返回表示路径的路径或字符串。它还可以获取 s 和/或字符串的列表，并返回路径列表。如果传递单个，则结果

与调用相同（见上文）。字符串可以具有嵌入式构造变量，这些变量像往常一样使用调用环境的变量集进行扩展。路径可以是文件或目录，并且不必

存在。NodeNodeNodestr(node)

env=Environment(VAR="value")

n=File("foo.c")

print(env.GetBuildPath([n, "sub/dir/$VAR"]))

将打印以下文件名：

% scons -Q

['foo.c', 'sub/dir/value']

scons: `.' is up to date.

还有一个函数版本的 GetBuildPath，可以在没有环境的情况下调用;它使用默认的 SCons 环境对任何字符串参数执行替换。

第 6 章。依赖

到目前为止，我们已经看到了 SCons 如何处理一次性构建。但是，像SCons这样的构建工具的主要功能之一是仅在源文件更改时重建必要的内容 - 或者

换句话说，SCons

不应该

浪费时间重建不需要重建的东西。您只需在构建我们的简单示例后重新调用 SCons 即可看到这一点：hello

% scons -Q

cc -o hello.o -c hello.c

cc -o hello hello.o

% scons -Q

scons: `.' is up to date.

第二次执行时，SCons 会意识到该程序相对于当前源文件是最新的，并避免重新生成它。通过在命令行上显式命名程序，可以更清楚地看到这一点：

hellohello.chello

% scons -Q hello

cc -o hello.o -c hello.c

cc -o hello hello.o

% scons -Q hello

scons: `hello' is up to date.

请注意，SCons 仅报告在命令行上显式命名的目标文件，以避免使输出混乱。"...is up to date"

6.1. 决定输入文件何时更改：决策器函数

避免不必要的重建的另一个方面是在输入文件更改时

重建

事物的基本构建工具行为，以便构建的软件是最新的。默认情况下，SCons 通过每个文件

的

内容的内容签名

或哈希来跟踪这一点，尽管您可以轻松地将 SCon 配置为使用修改时间（或时间戳）。您甚至可以编写自己的Python函数来决定输入

文件是否应该触发重建。

6.1.1. 使用内容签名来决定文件是否已更改

默认情况下，SCons 使用文件内容的加密哈希（而不是文件的修改时间）来决定文件是否已更改。这意味着，如果您习惯于通过更新文件的修改时间

（例如，使用触摸命令）强制重建的 Make 约定，您可能会对默认的 SCons 行为感到惊讶：

% scons -Q hello

cc -o hello.o -c hello.c

cc -o hello hello.o

% touch hello.c

% scons -Q hello

scons: `hello' is up to date.

即使文件的修改时间已更改，SCons 也意识到文件的内容

未

更改，因此不需要重新生成程序。这样可以避免不必要的重建，例如，当有人在不进行更

改的情况下重写文件的内容时。但是，如果文件的内容确实发生了更改，则 SCons 会检测到更改并根据需要重新生成程序：hello.chello

% scons -Q hello

cc -o hello.o -c hello.c

cc -o hello hello.o

% [CHANGE THE CONTENTS OF hello.c]

% scons -Q hello

cc -o hello.o -c hello.c

cc -o hello hello.o

请注意，如果您愿意，可以使用 Decider 函数显式指定使用内容签名的默认行为，如下所示：

Program('hello.c')

Decider('content')

2022/10/8 23:29

图标 4.4.0

https://scons.org/doc/production/HTML/scons-user.html

17/179

您还可以在调用 Decider 函数时使用该字符串作为同义词 - 此旧名称已弃用，因为 SCons 现在支持选择哈希函数，而不仅仅是 MD5 函

数。'MD5''content'

6.1.1.1. 使用内容签名的后果

使用内容签名来确定输入文件是否已更改有一个令人惊讶的好处：如果源文件已更改，则重建的目标文件的内容将与上次构建文件时完全相同，那么

依赖于重建但未更改的目标文件的任何“下游”目标文件实际上都不需要重新构建。

因此，例如，如果用户仅更改文件中的注释，则重建的文件将与先前构建的文件完全相同（假设编译器未在对象文件中放置任何特定于构建的信

息）。然后，SCons 会意识到它不需要按如下方式重建程序：hello.chello.ohello

% scons -Q hello

cc -o hello.o -c hello.c

cc -o hello hello.o

% [CHANGE A COMMENT IN hello.c]

% scons -Q hello

cc -o hello.o -c hello.c

scons: `hello' is up to date.

从本质上讲，当 SCons 意识到目标文件已重建为与上次构建完全相同的文件时，它会“短路”任何依赖构建。这确实需要一些额外的处理时间来读取目

标（）文件的内容，但是当避免的重建本来既耗时又昂贵时，通常会节省时间。hello.o

6.1.2. 使用时间戳来决定文件是否已更改

如果您愿意，可以将 SCon 配置为在决定是否需要重建目标时使用文件的修改时间，而不是文件内容。SCons 为您提供了两种使用时间戳来确定自上次

构建目标以来输入文件是否已更改的方法。

使用时间戳最熟悉的方式是 Make 的方式：也就是说，如果源文件的修改时间比目标文件

新

，则让 SCon 决定必须重建目标。为此，请按如下方式调用

决策程序函数：

Object('hello.c')

Decider('timestamp-newer')

这使得 SCon 在更新文件的修改时间时（例如，使用触摸命令）的行为类似于 Make：

% scons -Q hello.o

cc -o hello.o -c hello.c

% touch hello.c

% scons -Q hello.o

cc -o hello.o -c hello.c

而且，实际上，由于此行为与 Make 的行为相同，因此在调用 Decider 函数时，您还可以将字符串用作同义词：'make''timestamp-newer'

Object('hello.c')

Decider('make')

使用与Make完全相同的时间戳的一个缺点是，如果输入文件的修改时间突然比目标文件

旧

，则不会重建目标文件。例如，如果从备份存档还原源文件

的旧副本，则可能会发生这种情况。还原文件的内容可能与上次生成从属目标时不同，但不会重新生成目标，因为源文件的修改时间不比目标新。

由于 SCons 实际上在构建目标时都会存储有关源文件时间戳的信息，因此它可以通过检查源文件时间戳的完全匹配来处理这种情况，而不仅仅是源文

件是否比目标文件新。为此，请在调用决策程序函数时指定参数：'timestamp-match'

Object('hello.c')

Decider('timestamp-match')

以这种方式配置后，只要源文件的修改时间发生更改，SCons 就会重新生成目标。因此，如果我们使用该选项将的修改时间更改为旧日期（1989 年 1

月 1 日），SCons 仍将重建目标文件：touch -thello.c

% scons -Q hello.o

cc -o hello.o -c hello.c

% touch -t 198901010000 hello.c

% scons -Q hello.o

cc -o hello.o -c hello.c

通常，首选而不是的唯一原因是，如果您有某种特定的理由要求这种类似 Make 的行为，即当以其他方式修改的源文件较旧时不重新生成目标。

timestamp-newertimestamp-match

6.1.3. 使用 MD 签名和时间戳确定文件是否已更改

作为性能增强，SCons 提供了一种使用文件内容签名的方法，但仅在文件的时间戳发生更改时才读取这些内容。为此，请使用参数调用决策器函数，如

下所示：'content-timestamp'

Program('hello.c')

Decider('content-timestamp')

如此配置，SCons 仍将像使用时一样运行：Decider('content')

% scons -Q hello

cc -o hello.o -c hello.c

cc -o hello hello.o

% touch hello.c

% scons -Q hello

scons: `hello' is up to date.

% edit hello.c

[CHANGE THE CONTENTS OF hello.c]

% scons -Q hello

2022/10/8 23:29

图标 4.4.0

https://scons.org/doc/production/HTML/scons-user.html

18/179

cc -o hello.o -c hello.c

cc -o hello hello.o

但是，当构建是最新的时，上述输出中对 SCons 的第二次调用将通过简单地查看文件的修改时间来执行，而不是通过打开它并对其内容执行签名计算

来执行。这可以显著加快许多最新构建的速度。hello.c

使用的唯一缺点是，如果源文件在上次构建文件后的一秒钟内被修改，则 SCons

不会

重建目标文件。虽然大多数开发人员都在编程，但这在实践中并

不是问题，因为不太可能有人构建并考虑得足够快，以便在一秒钟内对源文件进行实质性更改。但是，某些生成脚本或持续集成工具可能依赖于自动

将更改应用于文件然后尽快重新生成的能力，在这种情况下，使用可能不合适。Decider('content-timestamp')Decider('content-timestamp')

6.1.4. 扩展SC：编写自己的自定义决策器函数

我们传递给 Decider 函数的不同字符串值基本上由 SCons 用于选择几个特定的内部函数之一，这些函数实现各种方法来确定依赖项（通常是源文件）

在生成目标文件后是否已更改。事实证明，您还可以提供自己的函数来决定依赖项是否已更改。

例如，假设我们有一个输入文件，其中包含大量数据，采用某种特定的常规格式，用于重建许多不同的目标文件，但每个目标文件实际上只依赖于输

入文件的一个特定部分。我们希望每个目标文件仅依赖于其输入文件部分。但是，由于输入文件可能包含大量数据，因此我们希望仅在其时间戳已更

改时才打开输入文件。这可以通过自定义决策器函数来完成，该函数可能如下所示：

Program('hello.c')

def decide_if_changed(dependency, target, prev_ni, repo_node=None):

if dependency.get_timestamp() != prev_ni.timestamp:

dep = str(dependency)

tgt = str(target)

if specific_part_of_file_has_changed(dep, tgt):

return True

return False

Decider(decide_if_changed)

请注意，在函数定义中，（输入文件）是第一个参数，然后是 .这两者都作为 SCons 对象传递给函数，我们使用 Python st r （）将其转换为字符串。

dependencytargetNode

第三个参数是一个对象，它保存上次构建目标时记录的有关依赖项的内容签名和/或时间戳信息。一个对象可以保存不同的信息，这取决于参数所表示

的事物的类型。对于普通文件，该对象具有以下属性：prev_niprev_nidependencyprev_ni

csig

内容签名：上次生成文件时文件内容的加密哈希或校验和。dependencytarget

size

上次生成目标时文件的大小（以字节为单位）。dependency

timestamp

上次生成文件的修改时间。dependencytarget

这些属性在首次运行时可能不存在。如果没有任何先前的构建，则不会创建任何目标，也不存在任何 DB 文件。因此，您应该始终检查所讨论的属性是

否可用（使用Python hasattr方法或 - 块）。.sconsignprev_nitryexcept

第四个参数是比较时如果不是 None，则使用。通常仅当目标节点仅存在于存储库中时才设置此项 repo_nodeNodeBuildInfo

请注意，忽略自定义 Decider 函数中的某些参数是完全正常的做法，如果它们不会影响您要确定依赖项文件是否已更改的方式。

最后，我们提出了一个基于决策函数的小示例。请注意，在每次函数调用期间，文件的签名信息必须通过 get_csig 进行初始化（这是强制性的！

csigdependency

env = Environment()

def config_file_decider(dependency, target, prev_ni, repo_node=None):

import os.path

# We always have to init the .csig value...

dep_csig = dependency.get_csig()

# .csig may not exist, because no target was built yet...

if not prev_ni.hasattr("csig"):

return True

# Target file may not exist yet

if not os.path.exists(str(target.abspath)):

return True

if dep_csig != prev_ni.csig:

# Some change on source file => update installed one

return True

return False

def update_file():

with open("test.txt", "a") as f:

f.write("some line\n")

update_file()

# Activate our own decider function

env.Decider(config_file_decider)

env.Install("install", "test.txt")

6.1.5. 混合不同的方法来决定文件是否发生了变化

2022/10/8 23:29

图标 4.4.0

https://scons.org/doc/production/HTML/scons-user.html

19/179

前面的示例都演示了调用全局决策程序函数来配置 SCons 所做的所有依赖项决策。但是，有时您希望能够为不同的目标配置不同的决策。如有必要，

您可以使用 env。决策器方法，用于仅影响使用特定施工环境构建的目标的配置决策。

例如，如果我们任意想要使用内容签名构建一个程序，并使用来自同一源的文件修改时间构建另一个程序，我们可以这样配置它：

env1 = Environment(CPPPATH = ['.'])

env2 = env1.Clone()

env2.Decider('timestamp-match')

env1.Program('prog-content', 'program1.c')

env2.Program('prog-timestamp', 'program2.c')

如果两个程序都包含相同的文件，则更新的修改时间（使用触摸命令）将导致仅重建：inc.hinc.hprog-timestamp

% scons -Q

cc -o program1.o -c -I. program1.c

cc -o prog-content program1.o

cc -o program2.o -c -I. program2.c

cc -o prog-timestamp program2.o

% touch inc.h

% scons -Q

cc -o program2.o -c -I. program2.c

cc -o prog-timestamp program2.o

6.2. 隐式依赖关系：构造变量$CPPPATH

现在假设我们的“Hello， World！”程序实际上有一行要将文件包含在编译中：#includehello.h

#include <hello.h>

int

main()

{

printf("Hello, %s!\n", string);

}

And, for completeness, the file looks like this: hello.h

#define string "world"

在这种情况下，我们希望 SCons 认识到，如果文件的内容发生更改，则必须重新编译该程序。为此，我们需要修改文件，如下所示：

hello.hhelloSConstruct

Program('hello.c', CPPPATH='.')

$CPPPATH值告诉 SCons 在当前目录（）中查找 C 源文件（或文件）包含的任何文件。在文件中分配此任务时：'.'.c.hSConstruct

% scons -Q hello

cc -o hello.o -c -I. hello.c

cc -o hello hello.o

% scons -Q hello

scons: `hello' is up to date.

% [CHANGE THE CONTENTS OF hello.h]

% scons -Q hello

cc -o hello.o -c -I. hello.c

cc -o hello hello.o

首先，请注意，SCons 从 in 变量构造了参数，以便编译将在本地目录中找到该文件。-I.'.'$CPPPATHhello.h

其次，要意识到 SCons 知道必须重建程序，因为它会扫描文件的内容，以查找指示编译中包含另一个文件的行。SCons 将这些记录为目标文件的

隐式

依赖项

，因此，当文件更改时，SCons 会意识到该文件包含它，并重建依赖于和文件的结果程序。

hellohello.c#includehello.hhello.chellohello.chello.h

与$LIBPATH变量一样，该变量可以是目录列表，也可以是用特定于系统的路径分隔字符分隔的字符串（POSIX/Linux 上的“：”，Windows 上的“;”）。

无论哪种方式，SCons 都会创建正确的命令行选项，以便以下示例：$CPPPATH

Program('hello.c', CPPPATH = ['include', '/home/project/inc'])

在 POSIX 或 Linux 上将如下所示：

% scons -Q hello

cc -o hello.o -c -Iinclude -I/home/project/inc hello.c

cc -o hello hello.o

就像在窗户上这样：

C:\>scons -Q hello.exe

cl /Fohello.obj /c hello.c /nologo /Iinclude /I\home\project\inc

link /nologo /OUT:hello.exe hello.obj

embedManifestExeCheck(target, source, env)

6.3. 缓存隐式依赖关系

扫描每个文件的行确实需要一些额外的处理时间。当您对大型系统进行完整构建时，扫描时间通常只占构建所花费总时间的很小一部分。但是，当您

重建

大型系统的全部或部分内容时，您最有可能注意到扫描时间：SCons可能需要一些额外的时间来“考虑”在发出第一个构建命令之前必须构建的内容

（或决定所有内容都是最新的，不需要重新构建任何内容）。#include

2022/10/8 23:29

图标 4.4.0

https://scons.org/doc/production/HTML/scons-user.html

20/179

在实践中，SCons 扫描文件可以节省与跟踪不正确的依赖项引入的细微问题所损失的潜在时间相关的时间。然而，SCons扫描文件时的“等待时间”可能

会惹恼等待构建完成的单个开发人员。因此，SCons 允许您缓存其扫描程序找到的隐式依赖项，以供以后的版本使用。您可以通过在命令行上指定以

下选项来执行此操作：--implicit-cache

% scons -Q --implicit-cache hello

cc -o hello.o -c hello.c

cc -o hello hello.o

% scons -Q hello

scons: `hello' is up to date.

如果不想每次都在命令行上指定，则可以通过在文件中设置该选项，使其成为生成的默认行为：--implicit-cacheimplicit_cacheSConscript

SetOption('implicit_cache', 1)

默认情况下，SCons 不会缓存这样的隐式依赖项，因为会导致 SCons 仅使用上次运行期间存储的隐式依赖项，而不检查这些依赖项是否仍然正确。具

体而言，这意味着指示 SCons 在以下情况下

不

“正确”重建：--implicit-cache--implicit-cache

使用时，SCons 将忽略可能对搜索路径（如或，）所做的任何更改。如果对的更改通常会导致使用来自不同目录的不同同名文件，这可能会导

致 SCon 无法重建文件。--implicit-cache$CPPPATH$LIBPATH$CPPPATH

使用时，SCons 将不会检测是否已将同名文件添加到搜索路径中比上次找到该文件的目录更前面的目录中。--implicit-cache

6.3.1. 隐式删除更改选项

使用缓存的隐式依赖项时，有时您希望“从头开始”，并让 SCon 重新扫描以前缓存其依赖项的文件。例如，如果最近安装了用于编译的外部代码的新版

本，则外部头文件将已更改，并且以前缓存的隐式依赖项将过期。您可以通过使用以下选项运行 SCon 来更新它们：--implicit-deps-changed

% scons -Q --implicit-deps-changed hello

cc -o hello.o -c hello.c

cc -o hello hello.o

% scons -Q hello

scons: `hello' is up to date.

在这种情况下，SCons 将重新扫描所有隐式依赖项并缓存信息的更新副本。

6.3.2. 隐式 -d eps-不变选项

默认情况下，在缓存依赖项时，SCons 会在文件被修改时注意到，并重新扫描该文件以查找任何更新的隐式依赖项信息。但是，有时您可能希望强制

SCon 使用缓存的隐式依赖项，即使源文件已更改也是如此。这可以加快构建速度，例如，当您更改了源文件但知道您没有更改任何行时。在这种情况

下，您可以使用以下选项：#include--implicit-deps-unchanged

% scons -Q --implicit-deps-unchanged hello

cc -o hello.o -c hello.c

cc -o hello hello.o

% scons -Q hello

scons: `hello' is up to date.

在这种情况下，SCons 将假定缓存的隐式依赖项是正确的，并且不会费心重新扫描已更改的文件。对于对源文件进行小的增量更改后的典型构建，节

省的成本可能不是很大，但有时性能的每一点改进都很重要。

6.4. 显式依赖关系：依赖关系函数

有时，一个文件依赖于 SCons 扫描程序未检测到的另一个文件。对于这种情况，SCons 允许您明确指定一个文件依赖于另一个文件，并且每当该文件

发生更改时都必须重新生成。这是使用“ 依赖 ”方法指定的：

hello = Program('hello.c')

Depends(hello, 'other_file')

% scons -Q hello

cc -c hello.c -o hello.o

cc -o hello hello.o

% scons -Q hello

scons: `hello' is up to date.

% edit other_file

[CHANGE THE CONTENTS OF other_file]

% scons -Q hello

cc -c hello.c -o hello.o

cc -o hello hello.o

请注意，依赖项（Depends 的第二个参数）也可能是 Node 对象的列表（例如，通过调用生成器返回）：

hello = Program('hello.c')

goodbye = Program('goodbye.c')

Depends(hello, goodbye)

在这种情况下，依赖关系将在目标之前构建：

% scons -Q hello

cc -c goodbye.c -o goodbye.o

cc -o goodbye goodbye.o

cc -c hello.c -o hello.o

cc -o hello hello.o

6.5. 来自外部文件的依赖关系：解析依赖函数

剩余178页未读，继续阅读

qq_42779949

粉丝: 0
资源: 2

SCons中文指南：Python脚本驱动的构建工具详解

SCons用户指南.pdf

scons 2.4.0 用户指南

scons用户手册（英文）

scons用户指南中文版

Scons使用手册

Hi3861_海思官方_第三方软件移植指南1

pocketsphinx在windows下的中文语音识别Demo

RT-Thread V1.0.0 SCONS入门：Python与自动化构建

Madagascar 中文版入门指南

CMake中文教程：C++项目管理指南

最新资源