desenvolvimento · Referência do comando
qzx scaffoldPython
O que faz
Cria uma estrutura básica para um programa em Python.
Maturidade do comando: Alpha
Disponível para uso real e feedback enquanto a interface e o comportamento ainda podem evoluir. Esta é a avaliação atual do checkout de desenvolvimento. Cada tag de release imutável futuro preservará a avaliação exata incluída nessa versão. Disponível no PyPI 0.2.2.0.15. A documentação corresponde ao checkout alpha 0.2.2.0.15.
Comportamento e proteções integradas
O modo real aplica as alterações solicitadas
Execução direta para esta operação
Usa uma ferramenta nativa quando necessário
Funciona sem usar a rede
Projetado para funcionar sem elevação
Esta classificação de segurança foi revisada por Claude Opus 5.5 (Anthropic) em relação ao digest de implementação sha256:207c52ef2cd531e5f2baa76ace2a972a547c1e9d6e642d4f89a1e983451345b6 em 2026-10-08.
Sintaxe exata
qzx scaffoldPython <project_name> [path] [with_tests] [create_venv] --jsonParâmetros
Deslize ou use a barra horizontal para ver todas as colunas.
| Nome | Tipo | Obrigatório | Padrão | Descrição |
|---|---|---|---|---|
| project_name | str | Sim | Não declarado | Nome do projeto Python que será criado |
| path | str | Não | "." | Caminho onde o projeto será criado (padrão: diretório atual) |
| with_tests | bool | Não | true | Indica se a estrutura de testes (pytest) será incluída |
| create_venv | bool | Não | false | Indica se um ambiente virtual será criado |
Exemplos de entrada
qzx scaffoldPython my_projectCriar um novo projeto Python chamado "my_project" no diretório atual
qzx scaffoldPython my_project /path/to/dir true trueCriar um novo projeto Python com testes e ambiente virtual no diretório indicado
qzx scaffoldPython api_service . falseCriar um novo projeto Python chamado "api_service" sem testes no diretório atual
Para obter o payload estruturado completo, adicione --json: qzx scaffoldPython <project_name> [path] [with_tests] [create_venv] --json
Exemplo de saída representativa
Este JSON ilustrativo deriva do contrato de resultado respaldado pela implementação atual. Mostra o que o comando pode retornar sem afirmar que seja uma execução gravada; os valores variam conforme entradas, máquina, permissões e ferramentas opcionais.
Comando do exemplo: 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
},
"create_venv": true,
"files_created": [
"C:\\project\\example.txt"
],
"name_was_normalized": true,
"next_steps": [
{
"id": "run",
"description": "Example value",
"cwd": "Example value",
"argv": [
"Example value"
]
}
],
"partial": true,
"project_name": "Example value",
"project_path": "C:\\project\\example.txt",
"report": "Analysis complete.\nNo blocking issues were found.",
"requested_project_name": "Example value",
"timestamp": "Example value",
"virtual_environment": {
"requested": true,
"status": "not_requested",
"path": "C:\\project\\example.txt",
"python": "Example value",
"message": "Example value"
},
"warnings": [
"Example value"
],
"with_tests": true
}Ver o contrato de resultado JSON
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"required": [
"message",
"meta",
"success"
],
"properties": {
"success": {
"type": "boolean"
},
"message": {
"type": "string"
},
"project_name": {
"description": "Normalized project name on success; original input on validation errors."
},
"project_path": {
"type": "string"
},
"with_tests": {
"type": "boolean"
},
"files_created": {
"type": "array",
"items": {
"type": "string"
}
},
"timestamp": {
"type": "string"
},
"partial": {
"type": "boolean"
},
"error": {
"type": "string"
},
"error_code": {
"type": "string"
},
"create_venv": {
"type": "boolean"
},
"requested_project_name": {
"type": "string"
},
"name_was_normalized": {
"type": "boolean"
},
"virtual_environment": {
"type": "object",
"required": [
"requested",
"status"
],
"properties": {
"requested": {
"type": "boolean"
},
"status": {
"enum": [
"not_requested",
"created",
"failed"
]
},
"path": {
"type": "string"
},
"python": {
"type": "string"
},
"message": {
"type": "string"
}
},
"additionalProperties": true,
"allOf": [
{
"if": {
"properties": {
"status": {
"const": "created"
}
}
},
"then": {
"required": [
"path",
"python"
],
"properties": {
"requested": {
"const": true
}
}
}
}
]
},
"warnings": {
"type": "array",
"items": {
"type": "string"
}
},
"report": {
"type": "string"
},
"next_steps": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"description",
"cwd",
"argv"
],
"properties": {
"id": {
"type": "string",
"enum": [
"run",
"install",
"test",
"build"
]
},
"description": {
"type": "string"
},
"cwd": {
"type": "string"
},
"argv": {
"type": "array",
"minItems": 1,
"items": {
"type": "string"
}
}
},
"additionalProperties": true
},
"description": "Suggested argv/cwd actions; QZX has not executed them."
},
"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
}
},
"additionalProperties": true
}Erros e limites
O contrato público exige success=false e uma message descritiva em caso de falha. Este catálogo ainda não declara uma taxonomia de erros específica para cada comando; revise o resultado e não infira códigos inexistentes.
O QZX está em alpha. Dependências opcionais, permissões e recursos do host podem alterar o resultado.
Fluxo de evidência: requer um destino descartável isolado.
Evidência e procedência
- Implementação
- src/qzx/commands/development/scaffold_python.py
- Testes
- Não foi encontrado um arquivo de teste específico com o mesmo nome do módulo; isso não demonstra ausência total de cobertura.
- Canal de documentação
- Documentação de desenvolvimento 0.2.2.0.15 · main · sha256:b91acee86268edb7cb018a94e089ff8e95835eda3f2cf08b39796c0ab9654693
- Disponibilidade
- 0.2.2.0.15 ou anterior
Continue explorando
Comandos relacionados
Estes comandos também pertencem à categoria desenvolvimento. Compare-os para escolher a operação que melhor resolve sua tarefa.