desarrollo · Referencia de comando

`qzx scaffoldPython`

Qué hace

Crea una estructura básica para un programa en Python.

Comando canónico: scaffoldPython

Alias aceptados: pythonScaff, newPython, createPython, makeScaffProgramPython

Distingue mayúsculas: no

Incluido en el paquete publicado

Disponible en PyPI 0.2.2.0.2. La documentación corresponde al checkout alpha 0.2.2.0.2.

Seguridad y efectos

Puede modificar estado

Sin parámetro dry-run documentado

Puede invocar programas nativos

Sin uso de red documentado

No requiere elevación de forma inherente

Esta clasificación de seguridad se revisó contra el digest de implementación sha256:aa641f8adac45bb2d22e95573d495b0b528830b37422a316eb1f476846042032 el 2026-07-24.

Sintaxis exacta

qzx scaffoldPython <project_name> [path] [with_tests] [create_venv] --json

Parámetros

Nombre	Tipo	Obligatorio	Predeterminado	Descripción
project_name	str	Sí	No declarado	Name of the Python project to create
path	str	No	"."	Path where to create the project (default: current directory)
with_tests	str	No	"true"	Whether to include test scaffolding (pytest)
create_venv	str	No	"false"	Whether to create a virtual environment

Ejemplos de entrada

qzx makeScaffProgramPython my_project

Creates a new Python project named "my_project" in the current directory

qzx makeScaffProgramPython my_project /path/to/dir true true

Creates a new Python project with tests and virtual environment in the specified directory

qzx pythonScaff api_service . false

Creates a new Python project named "api_service" without tests in the current directory

Para obtener la carga estructurada completa, añade --json: qzx scaffoldPython <project_name> [path] [with_tests] [create_venv] --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 makeScaffProgramPython my_project --json

{
    "success": true,
    "message": "Creates a basic scaffolding for a Python program. In this illustrative example, the command completed successfully.",
    "project_name": "Example value",
    "venv_warning": "Example value"
}

Ver el contrato de resultado JSON

{
    "$schema": "https://json-schema.org/draft/2020-12/schema",
    "type": "object",
    "required": [
        "success",
        "message"
    ],
    "properties": {
        "success": {
            "type": "boolean"
        },
        "message": {
            "type": "string"
        },
        "error": {
            "type": "string"
        },
        "project_name": [],
        "venv_warning": []
    },
    "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

Implementación: src/qzx/commands/development/scaffold_python.py
Pruebas: No se encontró un archivo de prueba específico con el mismo nombre de módulo; esto no demuestra ausencia total de cobertura.
Canal de documentación: Documentación de desarrollo 0.2.2.0.2 · main · sha256:319b16857a87636ebc3b89734cc040a737bb56194464fca33ce73bdae2043096
Disponibilidad: 0.2.2.0.2 o anterior

Sigue explorando

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