desarrollo · Referencia de comando
qzx scaffoldPython
Qué hace
Crea una estructura básica para un programa en 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.8. La documentación corresponde al checkout alpha 0.2.2.0.8.
Comportamiento y protecciones integradas
El modo real aplica los cambios que solicites
Ejecución directa para esta operación
Usa una herramienta nativa cuando hace falta
Funciona sin usar la red
Diseñado para funcionar sin elevación
Esta clasificación de seguridad fue revisada por OpenAI GPT-5.6 Pro contra el digest de implementación sha256:2ea54a52fba0e069c128efa2b86c9e7d3ce78fb808155155dd3d4911692f6746 el 2026-08-25.
Sintaxis exacta
qzx scaffoldPython <project_name> [path] [with_tests] [create_venv] --jsonParámetros
Desliza o usa la barra horizontal para ver todas las columnas.
| Nombre | Tipo | Obligatorio | Predeterminado | Descripción |
|---|---|---|---|---|
| project_name | str | Sí | No declarado | Nombre del proyecto Python que se creará |
| path | str | No | "." | Ruta en la que se creará el proyecto (valor predeterminado: directorio actual) |
| with_tests | bool | No | true | Indica si se incluye la estructura para pruebas (pytest) |
| create_venv | bool | No | false | Indica si se crea un entorno virtual |
Ejemplos de entrada
qzx scaffoldPython my_projectCrear un proyecto Python nuevo llamado "my_project" en el directorio actual
qzx scaffoldPython my_project /path/to/dir true trueCrear un proyecto Python nuevo con pruebas y entorno virtual en el directorio indicado
qzx scaffoldPython api_service . falseCrear un proyecto Python nuevo llamado "api_service" sin pruebas en el directorio actual
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 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
},
"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",
"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
},
"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.8 · main · sha256:9aa902dfb6b006017e52972bf7871fef49b03ec24ff80741231d743d0354bfc2
- Disponibilidad
- 0.2.2.0.8 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.