跳到主要内容

开发 · 命令参考

qzx addPythonDocstrings

作用

预览或向 Python 文件中的函数、方法和类添加生成的 docstring。

命令成熟度：Alpha

可用于真实使用和反馈，但其接口与行为仍可能继续演进。 这是当前开发 checkout 的评估。未来每个不可变发布标签都会保留该版本中包含的准确评估。 可在 PyPI 0.2.2.0.9 使用。文档对应 alpha checkout 0.2.2.0.9。

行为与内置保护

实际模式会应用你请求的更改

提供预览

无需调用原生程序即可运行

无需网络即可运行

设计为无需提权即可运行

QZX 会在实际更改前创建恢复文件；只有在你明确决定故意跳过它时才使用 --dangerously-bypass-approvals-and-sandbox/--yolo。

此安全分类由 OpenAI GPT-5.6 Pro 于 2026-08-25 对照实现摘要 sha256:49adb01eeda3ea929526a4b1d90b8cf67df0072bf654c68e41fe9118603e147d 审阅。

准确语法

qzx addPythonDocstrings <file_path> [style] [overwrite] [dry_run] --json

参数

滑动或使用横向滚动条查看所有列。

名称类型必填默认值描述
file_pathstr是未声明要处理的 Python 文件路径
stylestr否"google"文档风格（google、numpy 或 sphinx）
overwritebool否false是否覆盖现有 docstring
dry_runbool否true在不修改文件的情况下预览更改

输入示例

qzx addPythonDocstrings myfile.py

预览 myfile.py 的 Google 风格 docstring 模板

qzx addPythonDocstrings myfile.py sphinx

预览 myfile.py 的 Sphinx 风格 docstring 模板

qzx addPythonDocstrings myfile.py --dry-run false

备份 myfile.py，然后添加缺失的 Google 风格 docstring

qzx addPythonDocstrings myfile.py --overwrite --dry-run false

备份 myfile.py，然后替换现有 docstring

要获得完整结构化载荷，请添加 --json： qzx addPythonDocstrings <file_path> [style] [overwrite] [dry_run] --json

代表性输出示例

此示意 JSON 源自当前实现所支持的结果契约。它展示命令可能返回的内容，并不声称这是录制的实际执行；具体值会随输入、设备、权限和可选工具而变化。

示例命令： qzx addPythonDocstrings myfile.py --json

{
    "success": true,
    "message": "Previews or adds generated docstring templates to functions, methods, and classes in one Python file. In this illustrative example, the command completed successfully.",
    "meta": {
        "command": "addPythonDocstrings",
        "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
    },
    "changes_applied": "Example value",
    "changes_detected": "Example value",
    "changes_made": "Example value",
    "changes_preview": [
        "Add a module docstring.",
        "Document the public function."
    ],
    "details": {
        "file_path": "C:\\project\\example.txt"
    },
    "dry_run": true,
    "file_path": "C:\\project\\example.txt",
    "overwrite": true,
    "stats": {
        "summary": "Additional structured context is included here."
    },
    "status": "ok",
    "style": "Example value"
}
查看 JSON 结果契约
{
    "$schema": "https://json-schema.org/draft/2020-12/schema",
    "type": "object",
    "required": [
        "success",
        "message",
        "meta"
    ],
    "properties": {
        "success": {
            "type": "boolean"
        },
        "message": {
            "type": "string"
        },
        "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
        },
        "changes_applied": [],
        "changes_detected": [],
        "changes_made": [],
        "changes_preview": [],
        "details": {
            "type": "object",
            "properties": {
                "file_path": []
            },
            "additionalProperties": true
        },
        "dry_run": [],
        "error": {
            "type": "string"
        },
        "error_code": {
            "type": "string"
        },
        "file_path": [],
        "overwrite": [],
        "stats": [],
        "status": {
            "type": "string"
        },
        "style": []
    },
    "additionalProperties": true
}

错误与限制

公开契约要求失败时返回 success=false 和具有描述性的 message。此目录尚未为每个命令声明专门的错误分类；请检查结果，不要推断不存在的错误码。

QZX 仍处于 alpha 阶段。可选依赖、权限和主机能力可能影响结果。

证据流程：需要隔离的可丢弃目标。

证据与来源

文档渠道
开发文档 0.2.2.0.9 · main · sha256:cfba936e39931c286ca23add0ae546693db17d8b316e7cbc3891d26642d9b7e8
可用性
0.2.2.0.9 或更早

继续探索

相关命令

这些命令同样属于 开发 类别。对比它们，选择最适合解决任务的操作。

浏览所有 QZX 命令