本文介绍 SCons，一个基于 Python 的开源跨平台构建系统。涵盖其历史、核心设计哲学（配置即代码、自动依赖分析）、功能特性（依赖管理、缓存、构建环境）、安装使用指南及与 Make/CMake/Meson 的对比。文章通过实际项目示例展示其在 C/C++、Python 扩展、嵌入式开发等场景的应用，并分析优缺点与最佳实践，适合需要灵活构建逻辑的开发者参考。
想象一下，如果你的构建配置文件可以像 Python 代码一样：
这就是SCons——一个用 Python 编写的、跨平台的、开源的构建系统。它不仅仅是 Make 的替代品，更是构建系统设计理念的一次革命。
SCons（Software Construction tool）是一个基于 Python 的构建工具，它使用 Python 脚本作为构建配置文件。核心特点包括：
Make: Makefile（自定义语法） → Make → 构建
CMake: CMakeLists.txt（CMake 语言） → 生成器 → 构建
SCons: SConstruct（Python 代码） → SCons → 构建
关键区别：SCons 构建文件是可执行的 Python 程序，而非配置文件。
背景：
Cons 的关键创新：
进化：
重要里程碑：
社区增长：
版本 1.0：2005 年发布，标志稳定性 广泛采用：
当前状态：
# SConstruct 文件是真正的 Python 代码
env = Environment(CCFLAGS='-O2')
env.Program('hello', 'hello.c')
# 可以使用所有 Python 特性
import sys
if sys.platform == 'win32':
env.Append(CCFLAGS='/MD')
# SCons 自动分析依赖
env.Program('app', ['main.c', 'utils.c'])
# 自动检测 main.c 包含的头文件
# 自动检测 utils.c 包含的头文件
# 头文件改变时自动重新编译
# 自动分析 C/C++ 包含关系
env = Environment()
env.Program('app', 'main.c')
# 如果 main.c 包含 header.h
# SCons 自动检测并添加依赖
# 修改 header.h 会自动触发重新编译
# 自定义扫描器
def my_scanner(node, env, path):
# 分析文件内容，返回依赖列表
return ['dep1.h', 'dep2.h']
# 注册扫描器
scanner = Scanner(function=my_scanner, skeys=['.myext']) # 文件扩展名
env.Append(SCANNERS=scanner)
# 使用 MD5 哈希而非时间戳
# 避免因时间戳改变导致的误重建
# 文件内容相同 → MD5 相同 → 不需要重建
# 共享缓存，加速团队构建
CacheDir('/var/cache/scons')
# 衍生文件缓存
env = Environment()
env.CacheDir('cache')
# 创建构建环境
env = Environment(
CC='gcc',
CCFLAGS=['-O2', '-Wall'],
CPPDEFINES={'DEBUG': 1},
LIBS=['m', 'pthread']
)
# 克隆和修改环境
debug_env = env.Clone()
debug_env.Append(CCFLAGS='-g')
# 平台特定配置
if env['PLATFORM'] == 'win32':
env.Append(LIBS=['ws2_32'])
# 内置构建器
env.Program('app', 'main.c') # 可执行文件
env.StaticLibrary('lib', 'src.c') # 静态库
env.SharedLibrary('dll', 'src.c') # 动态库
# 自定义构建器
def build_myfile(target, source, env):
# 自定义构建逻辑
with open(target[0].path, 'w') as f:
f.write('Built from ' + source[0].path)
return 0
my_builder = Builder(action=build_myfile)
env.Append(BUILDERS={'MyBuilder': my_builder})
env.MyBuilder('output.txt', 'input.txt')
# 定义别名
Alias('install', '/usr/local/bin/app')
Alias('all', ['app', 'tests'])
# 默认目标
Default('app') # 运行 scons 时默认构建 app
# 清理
env.Alias('clean', Clean('app', 'app.exe'))
# 使用多核构建
scons -j4 # 4 个并行任务
scons -j auto # 自动检测 CPU 核心数
# 在 SConstruct 中控制
SetOption('num_jobs', 4)
# 构建前执行
def before_build(target, source, env):
print(f"Building {target[0]}")
# 构建后执行
def after_build(target, source, env):
print(f"Built {target[0]}")
# 添加钩子
env.AddPreAction('app', before_build)
env.AddPostAction('app', after_build)
# 安装 SCons
pip install scons
# 验证安装
scons --version
# 升级 SCons
pip install --upgrade scons
# SConstruct 文件
# 1. 创建构建环境
env = Environment()
# 2. 设置编译选项
env.Append(CCFLAGS=['-Wall', '-O2'])
env.Append(CPPDEFINES={'VERSION': '1.0.0'})
# 3. 构建可执行文件
env.Program(target='hello', source='hello.c')
# 4. 构建库
env.StaticLibrary(target='mylib', source=['lib1.c', 'lib2.c'])
# 5. 使用库
env.Program(target='app', source='main.c', LIBS=['mylib'], LIBPATH='.')
# 运行：scons
# 复杂项目示例
# SConstruct（顶层）
env = Environment()
# 导出环境给子目录
Export('env')
# 构建子目录
SConscript('src/SConscript', variant_dir='build/src', duplicate=0)
SConscript('tests/SConscript', variant_dir='build/tests', duplicate=0)
# 默认目标
Default('all')
# src/SConscript
# 导入环境
Import('env')
# 构建库
sources = Glob('*.c')
env.StaticLibrary('mylib', sources)
# 构建可执行文件
env.Program('myapp', 'main.c', LIBS=['mylib'])
# 基本构建
scons # 构建默认目标
scons program # 构建特定目标
scons -c # 清理构建产物
scons -Q # 安静模式，减少输出
scons --debug=explain # 解释为什么需要重建
# 并行构建
scons -j4 # 4 个并行任务
scons -j auto # 自动检测 CPU 核心数
# 安装和卸载
scons install # 安装到系统
scons uninstall # 卸载
# 配置选项
scons debug=1 # 传递参数给 SConstruct
scons CC=clang # 指定编译器
# 查看帮助
scons -H # 显示所有选项
# SConstruct
import os
# 创建环境
env = Environment(
CXX='g++',
CXXFLAGS=['-std=c++17', '-Wall'],
ENV={'PATH': os.environ['PATH']}
)
# 平台特定配置
platform = env['PLATFORM']
if platform == 'win32':
env.Append(CXXFLAGS=['/EHsc', '/MD'])
env.Append(LIBS=['ws2_32', 'advapi32'])
elif platform == 'posix':
env.Append(CXXFLAGS=['-pthread'])
env.Append(LIBS=['pthread', 'm'])
# 根据配置选项调整
debug = ARGUMENTS.get('debug', 0)
if int(debug):
env.Append(CXXFLAGS=['-g', '-O0'])
env.Append(CPPDEFINES={'DEBUG': 1})
else:
env.Append(CXXFLAGS=['-O2', '-DNDEBUG'])
# 源文件
sources = ['src/main.cpp', 'src/core.cpp', 'src/utils.cpp', 'src/networking.cpp']
# 构建
env.Program('myapp', sources)
# 安装规则
env.Install('/usr/local/bin', 'myapp')
env.Alias('install', '/usr/local/bin/myapp')
# 构建 Python C 扩展
env = Environment(tools=['default', 'mingw'])
# 获取 Python 配置
py_config = env.ParseConfig('python3-config --includes --libs')
# 构建扩展
env.SharedLibrary(
target='mymodule',
source=['mymodule.c', 'helper.c'],
CCFLAGS=py_config['CPPFLAGS'],
LINKFLAGS=py_config['LDFLAGS'],
LIBS=py_config['LIBS']
)
# 安装到 Python site-packages
site_packages = env.ParseConfig('python3 -c "import site; print(site.getsitepackages()[0])"')
env.Install(site_packages, 'mymodule.so')
# 交叉编译嵌入式项目
# arm_toolchain.py - 工具链定义
def generate(env):
env['CC'] = 'arm-none-eabi-gcc'
env['CXX'] = 'arm-none-eabi-g++'
env['AR'] = 'arm-none-eabi-ar'
env['OBJCOPY'] = 'arm-none-eabi-objcopy'
env['SIZE'] = 'arm-none-eabi-size'
env.Append(
CCFLAGS=['-mcpu=cortex-m4', '-mthumb', '-mfpu=fpv4-sp-d16', '-mfloat-abi=hard', '-ffunction-sections', '-fdata-sections'],
LINKFLAGS=['-T', 'linker.ld', '-nostartfiles', '-Wl,--gc-sections', '-specs=nano.specs']
)
# SConstruct 中使用工具链
env = Environment(tools=['arm_toolchain'])
env.Program('firmware.elf', Glob('src/*.c'))
# 生成二进制文件
env.AddPostAction('firmware.elf', '$OBJCOPY -O binary $SOURCE $TARGET.bin')
# 构建时生成代码
def generate_config(source, target, env):
with open(target[0].path, 'w') as f:
f.write(f'#define VERSION "{env["VERSION"]}"\n')
f.write(f'#define BUILD_TIME "{env["BUILD_TIME"]}"\n')
# 创建生成器
config_builder = Builder(action=generate_config)
env.Append(BUILDERS={'ConfigBuilder': config_builder})
# 生成配置文件
config_file = env.ConfigBuilder('config.h', 'config.h.in')
env.Depends('app', config_file) # 添加依赖
# 自定义依赖扫描器
import re
def scan_myformat(node, env, path):
content = node.get_text_contents()
# 查找特定模式的依赖
deps = re.findall(r'@import\s+"([^"]+)"', content)
return [env.File(dep) for dep in deps]
# 注册扫描器
my_scanner = Scanner(function=scan_myformat, skeys=['.myfmt'])
env.Append(SCANNERS=my_scanner)
# 多构建变体
variants = ['debug', 'release']
builds = {}
for variant in variants:
# 为每个变体创建独立环境
build_env = env.Clone()
if variant == 'debug':
build_env.Append(CCFLAGS=['-g', '-O0'])
build_env.Append(CPPDEFINES={'DEBUG': 1})
output_dir = 'build/debug'
else:
build_env.Append(CCFLAGS=['-O2', '-DNDEBUG'])
output_dir = 'build/release'
# 设置输出目录
build_env.VariantDir(output_dir, '.', duplicate=0)
# 构建
build_env.Program(f'{output_dir}/app', f'{output_dir}/main.c')
builds[variant] = f'{output_dir}/app'
# 默认构建所有变体
Default(builds.values())
| 特性 | SCons | GNU Make |
|---|---|---|
| 配置语言 | Python | Makefile 语言 |
| 依赖分析 | 自动分析包含关系 | 手动指定或使用 gcc -MMD |
| 跨平台 | 优秀，行为一致 | 需要平台适配 |
| 可靠性 | MD5 内容签名 | 时间戳，可能误判 |
| 扩展性 | Python，无限可能 | 有限，需要 shell 脚本 |
| 学习曲线 | 需要 Python 知识 | 需要学习 Make 语法 |
| 特性 | SCons | CMake |
|---|---|---|
| 哲学 | 配置即代码 | 配置然后生成 |
| 语言 | Python | CMake 自定义语言 |
| 构建后端 | 直接构建 | 生成 Makefile/Ninja 等 |
| IDE 集成 | 有限 | 优秀（生成 IDE 项目） |
| 依赖管理 | 内置自动扫描 | 需要 find_package |
| 企业采用 | 较少 | 广泛 |
| 特性 | SCons | Meson |
|---|---|---|
| 语法 | Python 代码 | 声明式 DSL |
| 速度 | 较慢（Python 启动） | 快（生成 Ninja） |
| 现代性 | 较传统（2000 年设计） | 现代化设计 |
| 依赖管理 | 需要手动配置 | 内置 WrapDB 支持 |
| 社区 | 稳定但增长慢 | 快速增长 |
# LLVM 子项目构建测试（1000 个 C 文件）
# 时间对比：
# SCons: 45 秒
# Make: 30 秒 # 快 33%
# Ninja: 15 秒 # 快 66%
# 内存使用：
# SCons: 350MB # Python 解释器开销
# Make: 50MB
# Ninja: 30MB
# 结论：SCons 在速度上不占优，但在灵活性和正确性上有优势
# 可以使用所有 Python 特性
import json
import hashlib
import subprocess
# 动态生成构建规则
config = json.load(open('config.json'))
for module in config['modules']:
env.Program(module['name'], module['sources'])
# 同一份 SConstruct 在所有平台工作
# 无需为不同平台编写特殊逻辑
if env['PLATFORM'] == 'win32':
# Windows 特定设置
elif env['PLATFORM'] == 'darwin':
# macOS 特定设置
project/
├── SConstruct # 根构建文件
├── src/
│ ├── SConscript # 源代码构建
│ └── *.c
├── include/
│ └── *.h
├── tests/
│ ├── SConscript # 测试构建
│ └── *.c
├── tools/
│ └── custom_tool.py # 自定义工具
└── site_scons/ # 站点特定配置
└── site_tools/ # 自定义工具链
# site_scons/site_init.py - 站点初始化
def site_init(env):
"""站点默认配置"""
env.Append(CCFLAGS=['-Wall', '-Wextra'])
# 在 SConstruct 中使用
import site_scons
site_scons.site_init(env)
# 从配置文件读取选项
import json
config = json.load(open('build_config.json'))
# 使用选项
env = Environment()
if config.get('debug', False):
env.Append(CCFLAGS=['-g', '-O0'])
# 1. 使用 Decider('MD5-timestamp')
# 混合 MD5 和时间戳，提高速度
env.Decider('MD5-timestamp')
# 2. 启用缓存
CacheDir('/tmp/scons_cache')
# 3. 并行构建
SetOption('num_jobs', 8)
# 4. 减少不必要的扫描
env.DecideSource(Glob('*.c'), 'timestamp')
# 构建 Python 包
env = Environment()
# 构建 C 扩展
env.SharedLibrary('mypackage/_native', 'src/native.c')
# 打包
env.Command('dist/mypackage.tar.gz', ['mypackage/', 'setup.py', 'README.md'], 'python setup.py sdist')
# 科学计算项目通常需要复杂的数据处理流程
def build_pipeline(env):
# 数据预处理
env.Command('data/processed.csv', 'data/raw.csv', 'python scripts/preprocess.py $SOURCE $TARGET')
# 模型训练
env.Command('models/model.pkl', 'data/processed.csv', 'python scripts/train.py $SOURCE $TARGET')
# 可视化
env.Command('reports/figure.png', ['data/processed.csv', 'models/model.pkl'], 'python scripts/visualize.py $SOURCES $TARGET')
# SCons 可以管理整个数据科学流水线
# 复杂的嵌入式构建流程
env = Environment(tools=['arm_gcc'])
# 构建固件
elf = env.Program('firmware.elf', Glob('src/*.c'))
# 生成多个输出格式
env.AddPostAction(elf, [
'$OBJCOPY -O binary $SOURCE ${TARGET}.bin',
'$OBJCOPY -O ihex $SOURCE ${TARGET}.hex',
'$SIZE $SOURCE > ${TARGET}.size'
])
# 编程设备
env.Command('program', 'firmware.elf.bin', 'openocd -f interface.cfg -c "program $SOURCE reset exit"')
# 管理文档构建
env = Environment()
# 多种输出格式
env.Command('manual.pdf', 'manual.md', 'pandoc $SOURCE -o $TARGET --pdf-engine=xelatex')
env.Command('manual.html', 'manual.md', 'pandoc $SOURCE -o $TARGET --self-contained')
env.Command('manual.epub', 'manual.md', 'pandoc $SOURCE -o $TARGET')
# 依赖图
env.Command('deps.png', 'SConstruct', 'scons --tree=all | dot -Tpng -o $TARGET')
# 内置工具
env = Environment(tools=[
'default', # 默认工具
'mingw', # MinGW 支持
'msvc', # Visual Studio
'gcc', # GCC 特定
'clang', # Clang 支持
'gnulink', # GNU 链接器
'ar', # 归档工具
'lex', # Lex/Yacc
'yacc',
'qt', # Qt 支持
'java', # Java 构建
'swig', # SWIG 接口生成
])
# 第三方工具
# https://scons.org/wiki/ToolsIndex
# 生成 IDE 项目文件
# Visual Studio 生成器
env.MSVSProject(
target='MyProject.vcxproj',
srcs=['src/main.c'],
buildtarget=['program.exe']
)
# Eclipse CDT 生成器
env.EclipseProject(
target='.project',
srcs=Glob('src/*.c')
)
# GitHub Actions 示例
name: SCons Build
on: [push]
jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- name: Install SCons
run: pip install scons
- name: Configure and Build
run: |
scons configure
scons -j4
- name: Run Tests
run: scons test
即使 SCons 不再是最流行的构建系统，它的设计理念影响了后来的构建系统：
SCons 代表了构建系统设计的一种哲学：使用真正的编程语言来描述构建。它的成功和局限都源于这一选择：
适合的场景：
不适合的场景：
即使你不选择 SCons 作为主要构建系统，学习它仍有价值：
# 如果你想尝试 SCons：
pip install scons
# 创建一个简单项目：
cat > SConstruct << EOF
env = Environment()
env.Program('hello', 'hello.c')
EOF
# 体验 Python 驱动的构建
scons -Q
资源推荐：
SCons 可能不是每个人的首选构建系统，但对于那些欣赏 Python 之美、重视灵活性和正确性的开发者来说，它仍然是一个强大的选择。在构建系统的世界里，SCons 证明了：有时候，最好的配置语言就是你已经知道的编程语言。
微信公众号「极客日志」，在微信中扫描左侧二维码关注。展示文案：极客日志 zeeklog
解析常见 curl 参数并生成 fetch、axios、PHP curl 或 Python requests 示例代码。 在线工具，curl 转代码在线工具，online
将字符串编码和解码为其 Base64 格式表示形式即可。 在线工具，Base64 字符串编码/解码在线工具，online
将字符串、文件或图像转换为其 Base64 表示形式。 在线工具，Base64 文件转换器在线工具，online
将 Markdown（GFM）转为 HTML 片段，浏览器内 marked 解析；与 HTML 转 Markdown 互为补充。 在线工具，Markdown 转 HTML在线工具，online
将 HTML 片段转为 GitHub Flavored Markdown，支持标题、列表、链接、代码块与表格等；浏览器内处理，可链接预填。 在线工具，HTML 转 Markdown在线工具，online
通过删除不必要的空白来缩小和压缩JSON。 在线工具，JSON 压缩在线工具，online