development · Command reference

`qzx addPythonDocstrings`

What it does

Previews or adds generated docstring templates to functions, methods, and classes in one Python file

Command maturity: Alpha

Available for real use and feedback while its interface and behavior can still evolve. This is the current development-checkout assessment. Every future immutable release tag preserves the exact assessment shipped by that version. Available in PyPI 0.2.2.0.6a11. This page documents the 0.2.2.0.6a11 alpha development checkout.

Safety and effects

Can mutate state

Documented dry-run parameter

No native program invocation in the current classification

No documented network use

No inherent elevation requirement

Before mutation, QZX creates a recovery archive; --dangerously-bypass-approvals-and-sandbox/--yolo explicitly skips it.

This safety classification was reviewed by OpenAI Codex (authorized project audit) against implementation digest sha256:55c9dcb1be87ededd687e2311a871c8807f2d1ca929472459e3a0b1d0dbc4eb9 on 2026-07-30.

Exact syntax

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

Parameters

Swipe or use the horizontal scrollbar to see every column.

Name	Type	Required	Default	Description
file_path	str	Yes	Not declared	Path to the Python file to process
style	str	No	"google"	Documentation style (google, numpy, sphinx)
overwrite	bool	No	false	Whether to overwrite existing docstrings
dry_run	bool	No	true	Preview changes without modifying the file

Input examples

qzx addPythonDocstrings myfile.py

Preview Google-style docstring templates for myfile.py

qzx addPythonDocstrings myfile.py sphinx

Preview Sphinx-style docstring templates for myfile.py

qzx addPythonDocstrings myfile.py --dry-run false

Back up myfile.py, then add missing Google-style docstrings

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

Back up myfile.py, then replace existing docstrings

For the complete structured payload, add --json: qzx addPythonDocstrings <file_path> [style] [overwrite] [dry_run] --json

Representative output example

This illustrative JSON is derived from the current implementation-backed result contract. It shows what the command can return without claiming a recorded execution; values vary with inputs, host, permissions, and optional tools.

Example command: 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."
    ],
    "dry_run": true,
    "file_path": "C:\\project\\example.txt",
    "overwrite": true,
    "stats": {
        "summary": "Additional structured context is included here."
    },
    "status": "ok",
    "style": "Example value"
}

View the JSON result contract

{
    "$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": [],
        "dry_run": [],
        "error": {
            "type": "string"
        },
        "error_code": {
            "type": "string"
        },
        "file_path": [],
        "overwrite": [],
        "stats": [],
        "status": {
            "type": "string"
        },
        "style": []
    },
    "additionalProperties": true
}

Errors and limits

The public contract requires success=false and a descriptive message on failure. This catalog does not yet declare a command-specific error taxonomy; inspect the result and do not invent error codes.

QZX is alpha software. Optional dependencies, permissions, and host capabilities can change the result.

Evidence workflow: requires an isolated disposable target.

Evidence and provenance

Implementation: src/qzx/commands/development/add_python_docstrings.py
Tests: tests/test_development_commands/test_add_python_docstrings.py
Documentation channel: Development documentation 0.2.2.0.6a11 · main · sha256:d1bf56371df81b2a79619d8219eed92ccf790be1584c528e211381ca7aa85302
Availability: 0.2.2.0.6a11 or earlier

Keep exploring

These commands also belong to the development category. Compare them to choose the operation that best fits your task.

Explore all QZX commands