开发 · 命令参考
qzx scaffoldPython
作用
为 Python 程序创建基础结构。
命令成熟度：Alpha
可用于真实使用和反馈，但其接口与行为仍可能继续演进。 这是当前开发 checkout 的评估。未来每个不可变发布标签都会保留该版本中包含的准确评估。 可在 PyPI 0.2.2.0.15 使用。文档对应 alpha checkout 0.2.2.0.15。
行为与内置保护
实际模式会应用你请求的更改
此操作直接执行
需要时使用原生工具
无需网络即可运行
设计为无需提权即可运行
此安全分类由 Claude Opus 5.5 (Anthropic) 于 2026-10-08 对照实现摘要 sha256:207c52ef2cd531e5f2baa76ace2a972a547c1e9d6e642d4f89a1e983451345b6 审阅。
准确语法
qzx scaffoldPython <project_name> [path] [with_tests] [create_venv] --json参数
滑动或使用横向滚动条查看所有列。
| 名称 | 类型 | 必填 | 默认值 | 描述 |
|---|---|---|---|---|
| project_name | str | 是 | 未声明 | 要创建的 Python 项目名称 |
| path | str | 否 | "." | 创建项目的路径（默认：当前目录） |
| with_tests | bool | 否 | true | 是否包含测试结构（pytest） |
| create_venv | bool | 否 | false | 是否创建虚拟环境 |
输入示例
qzx scaffoldPython my_project在当前目录创建名为 "my_project" 的新 Python 项目
qzx scaffoldPython my_project /path/to/dir true true在指定目录创建带测试和虚拟环境的新 Python 项目
qzx scaffoldPython api_service . false在当前目录创建名为 "api_service" 且不含测试的新 Python 项目
要获得完整结构化载荷，请添加 --json： qzx scaffoldPython <project_name> [path] [with_tests] [create_venv] --json
代表性输出示例
此示意 JSON 源自当前实现所支持的结果契约。它展示命令可能返回的内容，并不声称这是录制的实际执行；具体值会随输入、设备、权限和可选工具而变化。
示例命令： qzx scaffoldPython my_project --json
{
"success": true,
"message": "Creates a basic scaffolding for a Python program. In this illustrative example, the command completed successfully.",
"meta": {
"command": "scaffoldPython",
"command_maturity": {
"stage": "alpha",
"label": "Alpha",
"sequence": 2,
"public_executable": true,
"stability": "interface_may_change",
"summary": "Available for real use and feedback while its interface and behavior can still evolve.",
"promotion_review_required": false,
"assessment_scope": "development_checkout"
},
"duration_ms": 0,
"schema_version": 1
},
"create_venv": true,
"files_created": [
"C:\\project\\example.txt"
],
"name_was_normalized": true,
"next_steps": [
{
"id": "run",
"description": "Example value",
"cwd": "Example value",
"argv": [
"Example value"
]
}
],
"partial": true,
"project_name": "Example value",
"project_path": "C:\\project\\example.txt",
"report": "Analysis complete.\nNo blocking issues were found.",
"requested_project_name": "Example value",
"timestamp": "Example value",
"virtual_environment": {
"requested": true,
"status": "not_requested",
"path": "C:\\project\\example.txt",
"python": "Example value",
"message": "Example value"
},
"warnings": [
"Example value"
],
"with_tests": true
}查看 JSON 结果契约
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"required": [
"message",
"meta",
"success"
],
"properties": {
"success": {
"type": "boolean"
},
"message": {
"type": "string"
},
"project_name": {
"description": "Normalized project name on success; original input on validation errors."
},
"project_path": {
"type": "string"
},
"with_tests": {
"type": "boolean"
},
"files_created": {
"type": "array",
"items": {
"type": "string"
}
},
"timestamp": {
"type": "string"
},
"partial": {
"type": "boolean"
},
"error": {
"type": "string"
},
"error_code": {
"type": "string"
},
"create_venv": {
"type": "boolean"
},
"requested_project_name": {
"type": "string"
},
"name_was_normalized": {
"type": "boolean"
},
"virtual_environment": {
"type": "object",
"required": [
"requested",
"status"
],
"properties": {
"requested": {
"type": "boolean"
},
"status": {
"enum": [
"not_requested",
"created",
"failed"
]
},
"path": {
"type": "string"
},
"python": {
"type": "string"
},
"message": {
"type": "string"
}
},
"additionalProperties": true,
"allOf": [
{
"if": {
"properties": {
"status": {
"const": "created"
}
}
},
"then": {
"required": [
"path",
"python"
],
"properties": {
"requested": {
"const": true
}
}
}
}
]
},
"warnings": {
"type": "array",
"items": {
"type": "string"
}
},
"report": {
"type": "string"
},
"next_steps": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"description",
"cwd",
"argv"
],
"properties": {
"id": {
"type": "string",
"enum": [
"run",
"install",
"test",
"build"
]
},
"description": {
"type": "string"
},
"cwd": {
"type": "string"
},
"argv": {
"type": "array",
"minItems": 1,
"items": {
"type": "string"
}
}
},
"additionalProperties": true
},
"description": "Suggested argv/cwd actions; QZX has not executed them."
},
"meta": {
"type": "object",
"required": [
"command",
"command_maturity",
"duration_ms",
"schema_version"
],
"properties": {
"command": {
"type": "string"
},
"command_maturity": {
"type": "object",
"required": [
"stage",
"label",
"sequence",
"public_executable",
"stability",
"summary",
"promotion_review_required",
"assessment_scope"
],
"properties": {
"stage": {
"type": "string"
},
"label": {
"type": "string"
},
"sequence": {
"type": "integer"
},
"public_executable": {
"type": "boolean"
},
"stability": {
"type": "string"
},
"summary": {
"type": "string"
},
"promotion_review_required": {
"type": "boolean"
},
"assessment_scope": {
"type": "string"
},
"note": {
"type": "string"
},
"review": {
"type": "object",
"required": [
"reviewed_on",
"rationale",
"evidence"
],
"properties": {
"reviewed_on": {
"type": "string",
"format": "date"
},
"rationale": {
"type": "string"
},
"evidence": {
"type": "array",
"minItems": 1,
"items": {
"type": "string"
}
},
"replacement": {
"type": "string"
}
},
"additionalProperties": false
}
},
"additionalProperties": true
},
"duration_ms": {
"type": "number"
},
"schema_version": {
"type": "integer"
}
},
"additionalProperties": true
}
},
"additionalProperties": true
}错误与限制
公开契约要求失败时返回 success=false 和具有描述性的 message。此目录尚未为每个命令声明专门的错误分类；请检查结果，不要推断不存在的错误码。
QZX 仍处于 alpha 阶段。可选依赖、权限和主机能力可能影响结果。
证据流程：需要隔离的可丢弃目标。
证据与来源
- 测试
- 未找到与模块同名的专用测试文件；这并不能证明完全没有测试覆盖。
- 文档渠道
- 开发文档 0.2.2.0.15 · main · sha256:b91acee86268edb7cb018a94e089ff8e95835eda3f2cf08b39796c0ab9654693
- 可用性
- 0.2.2.0.15 或更早
继续探索
相关命令
这些命令同样属于 开发 类别。对比它们，选择最适合解决任务的操作。