开发工具CLI代码生成【免费下载链接】cookiecutterA cross-platform command-line utility that creates projects from cookiecutters (project templates), e.g. Python package projects, C projects.项目地址https://gitcode.com/gh_mirrors/co/cookiecutter点击查看免费下载导读本指南围绕 Cookiecutter 的高级特性_jinja2_env_vars讲解如何在模板的cookiecutter.json中直接定制项目生成时使用的 Jinja2 渲染环境——从最常用的空白控制lstrip_blocks、trim_blocks到定界符替换variable_start_string/variable_end_string。读完本文你将掌握该配置项的完整语法、底层实现原理、可配置参数及其适用边界并能在自己的模板中安全地启用这些能力。一、什么是_jinja2_env_varsCookiecutter 生成项目时所有模板文件以及目录名、文件名都会经过一个 Jinja2Environment对象进行渲染。默认情况下这个环境使用 Cookiecutter 内置的严格模式配置但开发者可能需要对渲染行为做细粒度调整例如控制模板中{% ... %}块周围的空白处理修改变量定界符{{ }}以适应特殊场景传递其他 Jinja2Environment构造函数支持的参数。为此Cookiecutter 提供了一条特殊的下划线前缀的私有配置项_jinja2_env_vars。它定义在模板根目录的cookiecutter.json中以普通 JSON 对象的形式声明键名与 Jinja2Environment构造函数的参数名一一对应。二、官方示例控制模板空白官方文档给出的经典示例是在cookiecutter.json中启用lstrip_blocks与trim_blocks{ project_slug: sample, _jinja2_env_vars: {lstrip_blocks: true, trim_blocks: true} }这两个参数的作用trim_blocks开启后{% ... %}语句块如{% if %}、{% for %}之后的第一个换行符会被自动移除避免渲染结果中残留多余空行lstrip_blocks开启后{% ... %}语句块之前的空白字符会被剥离使模板源码可以缩进排版而渲染结果不会带上前导空格。仓库中的测试 tests/test_generate_files.pytest_generate_files_with_jinja2_environment正是用{lstrip_blocks: True, trim_blocks: True}渲染了tests/test-generate-files/input{{cookiecutter.food}}/simple-with-conditions.txt这一嵌套条件模板{% if cookiecutter %} {% if cookiecutter.food %} I eat {{ cookiecutter.food }} {% endif %} {% endif %}模板中{% ... %}前的缩进和块后的换行在开启两个参数后不会污染输出。测试断言渲染结果为单行I eat pizzä\n直接验证了空白控制效果——这正是该配置项最典型、最实用的场景。三、底层实现原理3.1 配置读取与传递_jinja2_env_vars的读取发生在 cookiecutter/utils.py 的create_env_with_context函数中def create_env_with_context(context: dict[str, Any]) - StrictEnvironment: Create a jinja environment using the provided context. envvars context.get(cookiecutter, {}).get(_jinja2_env_vars, {}) return StrictEnvironment(contextcontext, keep_trailing_newlineTrue, **envvars)关键点有二取值路径固定配置必须位于上下文根的cookiecutter键之下即cookiecutter.json中的_jinja2_env_vars展开传递字典通过**envvars展开为关键字参数原样传给 Jinja2Environment的构造函数。也就是说凡是 Jinja2Environment.__init__支持的参数都可以在这里声明。3.2 与默认环境的叠加规则StrictEnvironment的定义在 cookiecutter/environment.pyclass StrictEnvironment(ExtensionLoaderMixin, Environment): def __init__(self, **kwargs: Any) - None: super().__init__(undefinedStrictUndefined, **kwargs)从中可以提炼出三条叠加规则undefinedStrictUndefined由 Cookiecutter 硬编码传入保证模板中引用未定义变量时立即抛出错误而非静默输出空字符串。该行为不受_jinja2_env_vars影响你无法通过该配置项关闭严格模式——这是刻意的安全设计keep_trailing_newlineTrue同样由create_env_with_context固定注入确保文件末尾换行不被模板引擎吞掉从而避免生成文件意外丢失结尾换行其余参数则完全由你的_jinja2_env_vars决定未声明的项一律采用 Jinja2 默认值。3.3 扩展加载不受影响StrictEnvironment通过ExtensionLoaderMixincookiecutter/environment.py加载扩展先注册内置扩展JsonifyExtension、RandomStringExtension、SlugifyExtension、TimeExtension、UUIDExtension再合并cookiecutter.json中_extensions指定的自定义扩展。这一过程与_jinja2_env_vars完全正交——定制环境参数不会影响扩展的注册与加载。四、进阶用法自定义定界符_jinja2_env_vars并不局限于空白控制。仓库测试 tests/test_find.py 展示了另一个典型场景自定义变量定界符。fake-repo-pre2模板的目录名写作{%{cookiecutter.repo_name}%}对应的上下文配置为{ cookiecutter: { _jinja2_env_vars: { variable_start_string: {%{, variable_end_string: }%}, } } }这里通过variable_start_string和variable_end_string将默认的{{ ... }}改为{%{ ... }%}。值得注意的是定界符定制会同步影响模板目录的查找逻辑find_template见 cookiecutter/find.py正是用env.variable_start_string和env.variable_end_string来识别哪个子目录是项目模板if ( cookiecutter in str_path and env.variable_start_string in str_path and env.variable_end_string in str_path ): project_template Path(repo_dir, str_path) break因此当模板目录名使用了非默认定界符时必须在_jinja2_env_vars中同步声明对应的定界符否则find_template将抛出不带模板目录的NonTemplatedInputDirException——测试中的第三个用例正是用fake-repo-pre默认{{ }}目录名搭配自定义定界符来验证这一失败场景。五、可配置参数与使用注意事项5.1 常用可配置参数一览参数说明仓库中的验证lstrip_blocks剥离{% %}块前的空白tests/test_generate_files.pytrim_blocks移除{% %}块后的首个换行同上variable_start_string/variable_end_string自定义变量定界符tests/test_find.pyblock_start_string/block_end_string自定义语句块定界符由 Jinja2 环境透传支持comment_start_string/comment_end_string自定义注释定界符由 Jinja2 环境透传支持keep_trailing_newline保留文件末尾换行由 Cookiecutter 固定为True不可覆盖undefined未定义变量处理策略固定为StrictUndefined不可覆盖需要说明的是lstrip_blocks、trim_blocks、variable_start_string等参数的语义与默认值均继承自 Jinja2Environment本身_jinja2_env_vars只是把这些参数的设置入口暴露到了模板配置层上文表格中标注由 Jinja2 环境透传支持的行表示仓库通过**envvars无条件透传实际效果以 Jinja2 版本行为为准。5.2 注意事项以_开头是私有约定_jinja2_env_vars与其他下划线前缀配置如_extensions、_copy_without_render、_new_lines一样属于模板元配置而非用户提示变量不会出现在交互式提问中也不会被渲染进生成文件JSON 类型限制由于配置写在cookiecutter.json中参数值只能是 JSON 支持的布尔、字符串、数字等类型。函数、回调等复杂对象无法通过此途径配置这类需求应改在hooks/中通过 从 Python 调用 Cookiecutter 的方式自行构造环境全局生效_jinja2_env_vars作用于整个模板生成过程——目录名渲染、文件名渲染、文件内容渲染以及模板目录查找全部使用同一个环境对象不存在只对某类文件生效的细粒度控制严格模式不可关闭StrictUndefined是 Cookiecutter 的安全底线未定义变量会直接中断生成并给出明确报错。若模板中确有可能未定义的变量应使用 Jinja2 的default过滤器显式兜底而非尝试覆盖undefined参数与_new_lines的区别_jinja2_env_vars控制 Jinja2 模板引擎的解析与渲染行为而换行符输出由独立的_new_lines配置见 docs/advanced/new_line_characters.rst决定两者职责不同不要混淆。六、快速验证你可以用仓库自带的测试数据快速验证这一机制。在仓库根目录执行python -m pytest tests/test_generate_files.py::test_generate_files_with_jinja2_environment -v python -m pytest tests/test_find.py -v前者验证空白控制lstrip_blocks/trim_blocks后者验证自定义定界符及其对模板目录识别的影响。此外也可参考 tests/test-generate-files/input{{cookiecutter.food}}/simple-with-conditions.txt 中的嵌套条件模板对比开启与不开启该配置时的输出差异直观感受渲染结果的变化。总结_jinja2_env_vars是 Cookiecutter 将底层 Jinja2Environment配置能力暴露给模板作者的关键通道。通过一条简单的 JSON 配置即可控制空白处理、自定义定界符等渲染行为而无需修改 Cookiecutter 自身代码。理解其读取链路create_env_with_context→StrictEnvironment→ Jinja2Environment、叠加规则StrictUndefined与keep_trailing_newline固定、其余透传以及环境定制同时作用于模板查找这一联动效应是安全、高效使用该特性的前提。赞分享开发工具CLI代码生成【免费下载链接】cookiecutterA cross-platform command-line utility that creates projects from cookiecutters (project templates), e.g. Python package projects, C projects.项目地址https://gitcode.com/gh_mirrors/co/cookiecutter点击查看免费下载相关推荐Cookiecutter 1.4.0 技术解析严格 Jinja2 环境、模板扩展机制与配置路径展开Cookiecutter 1.4.0 技术解析严格 Jinja2 环境、模板扩展机制与配置路径展开 本文聚焦 Cookiecutter 1.4.0 版本的核心开发工具CLI代码生成Cookiecutter 模板扩展Template Extensions完全指南为 Jinja2 环境注入自定义过滤器、标签与全局函数Cookiecutter 模板扩展Template Extensions完全指南为 Jinja2 环境注入自定义过滤器、标签与全局函数 本文是 Cooki开发工具CLI代码生成深入理解FactoryBot自定义策略机制深入理解FactoryBot自定义策略机制 什么是FactoryBot策略 在测试数据生成工具FactoryBot中策略 Strategy 是一个核心概念它测试开发工具上一篇Agent Zero 新手指南5 分钟给 AI 配一台完整电脑附 Docker 一行命令启动下一篇终极指南Actual Budget桌面应用如何打造流畅原生财务管理体验创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考