Saltar al contenido principal

desarrollo · Referencia de comando

qzx addPythonDocstrings

Qué hace

Previsualiza o añade docstrings generadas a funciones, métodos y clases de un archivo Python.

Madurez del comando: Alpha

Disponible para uso real y retroalimentación mientras su interfaz y comportamiento todavía pueden evolucionar. Esta es la evaluación actual del checkout de desarrollo. Cada futuro tag inmutable de release conservará la evaluación exacta incluida en esa versión. Disponible en PyPI 0.2.2.0.9. La documentación corresponde al checkout alpha 0.2.2.0.9.

Comportamiento y protecciones integradas

El modo real aplica los cambios que solicites

Vista previa disponible

Funciona sin invocar programas nativos

Funciona sin usar la red

Diseñado para funcionar sin elevación

QZX crea un archivo de recuperación antes de los cambios reales; usa --dangerously-bypass-approvals-and-sandbox/--yolo solo cuando decidas omitirlo deliberadamente.

Esta clasificación de seguridad fue revisada por OpenAI GPT-5.6 Pro contra el digest de implementación sha256:49adb01eeda3ea929526a4b1d90b8cf67df0072bf654c68e41fe9118603e147d el 2026-08-25.

Sintaxis exacta

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

Parámetros

Desliza o usa la barra horizontal para ver todas las columnas.

NombreTipoObligatorioPredeterminadoDescripción
file_pathstrSíNo declaradoRuta del archivo Python que se procesará
stylestrNo"google"Estilo de documentación (google, numpy o sphinx)
overwriteboolNofalseIndica si se sobrescriben los docstrings existentes
dry_runboolNotruePrevisualiza los cambios sin modificar el archivo

Ejemplos de entrada

qzx addPythonDocstrings myfile.py

Previsualizar plantillas de docstrings con estilo Google para myfile.py

qzx addPythonDocstrings myfile.py sphinx

Previsualizar plantillas de docstrings con estilo Sphinx para myfile.py

qzx addPythonDocstrings myfile.py --dry-run false

Crear un respaldo de myfile.py y después añadir los docstrings con estilo Google que falten

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

Crear un respaldo de myfile.py y después reemplazar los docstrings existentes

Para obtener la carga estructurada completa, añade --json: qzx addPythonDocstrings <file_path> [style] [overwrite] [dry_run] --json

Ejemplo de salida representativa

Este JSON ilustrativo deriva del contrato de resultado respaldado por la implementación actual. Muestra lo que el comando puede devolver sin afirmar que es una ejecución grabada; los valores varían según entradas, equipo, permisos y herramientas opcionales.

Comando del ejemplo: 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"
}
Ver el contrato de resultado 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
}

Errores y límites

El contrato público exige success=false y un message descriptivo en fallos. Este catálogo aún no declara una taxonomía de errores específica para cada comando; revisa el resultado y no infieras códigos inexistentes.

QZX está en alpha. Dependencias opcionales, permisos y capacidades del host pueden cambiar el resultado.

Flujo de evidencia: requiere un destino desechable aislado.

Evidencia y procedencia

Canal de documentación
Documentación de desarrollo 0.2.2.0.9 · main · sha256:cfba936e39931c286ca23add0ae546693db17d8b316e7cbc3891d26642d9b7e8
Disponibilidad
0.2.2.0.9 o anterior

Sigue explorando

Comandos relacionados

Estos comandos también pertenecen a la categoría de desarrollo. Compáralos para elegir la operación que mejor resuelva tu tarea.

Explorar todos los comandos de QZX