pengembangan · Referensi perintah

`qzx scaffoldPython`

Apa fungsinya

Membuat struktur dasar untuk program Python.

Kematangan perintah: Alpha

Tersedia untuk penggunaan nyata dan umpan balik sementara antarmuka serta perilakunya masih dapat berkembang. Ini adalah evaluasi saat ini untuk checkout pengembangan. Setiap tag rilis immutable di masa mendatang akan mempertahankan evaluasi persis yang disertakan dalam versi tersebut. Tersedia di PyPI 0.2.2.0.9. Dokumentasi ini sesuai dengan checkout alpha 0.2.2.0.9.

Perilaku dan perlindungan bawaan

Mode nyata menerapkan perubahan yang Anda minta

Eksekusi langsung untuk operasi ini

Menggunakan alat native saat diperlukan

Berfungsi tanpa menggunakan jaringan

Dirancang untuk bekerja tanpa elevasi hak akses

Klasifikasi keamanan ini ditinjau oleh OpenAI GPT-5.6 Pro terhadap digest implementasi sha256:2ea54a52fba0e069c128efa2b86c9e7d3ce78fb808155155dd3d4911692f6746 pada 2026-08-25.

Sintaks persis

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

Parameter

Geser atau gunakan bilah horizontal untuk melihat semua kolom.

Nama	Tipe	Wajib	Default	Deskripsi
project_name	str	Ya	Tidak dideklarasikan	Nama proyek Python yang akan dibuat
path	str	Tidak	"."	Jalur tempat proyek akan dibuat (default: direktori saat ini)
with_tests	bool	Tidak	true	Menentukan apakah struktur pengujian (pytest) disertakan
create_venv	bool	Tidak	false	Menentukan apakah virtual environment dibuat

Contoh input

qzx scaffoldPython my_project

Buat proyek Python baru bernama "my_project" di direktori saat ini

qzx scaffoldPython my_project /path/to/dir true true

Buat proyek Python baru dengan pengujian dan virtual environment di direktori yang ditentukan

qzx scaffoldPython api_service . false

Buat proyek Python baru bernama "api_service" tanpa pengujian di direktori saat ini

Untuk mendapatkan payload terstruktur lengkap, tambahkan --json: qzx scaffoldPython <project_name> [path] [with_tests] [create_venv] --json

Contoh output representatif

JSON ilustratif ini berasal dari kontrak hasil yang didukung implementasi saat ini. Ini menunjukkan apa yang dapat dikembalikan perintah tanpa mengklaim sebagai eksekusi yang direkam; nilainya bervariasi menurut input, mesin, izin, dan alat opsional.

Perintah contoh: 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"
}

Lihat kontrak hasil 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
}

Kesalahan dan batasan

Kontrak publik mensyaratkan success=false dan message yang deskriptif saat gagal. Katalog ini belum mendeklarasikan taksonomi kesalahan khusus untuk setiap perintah; periksa hasil dan jangan menyimpulkan kode yang tidak ada.

QZX masih dalam tahap alpha. Dependency opsional, izin, dan kemampuan host dapat mengubah hasil.

Alur bukti: memerlukan target terisolasi yang dapat dibuang.

Bukti dan asal-usul

Implementasi: src/qzx/commands/development/scaffold_python.py
Pengujian: Tidak ditemukan file pengujian khusus dengan nama modul yang sama; ini tidak membuktikan bahwa cakupan pengujian sama sekali tidak ada.
Kanal dokumentasi: Dokumentasi pengembangan 0.2.2.0.9 · main · sha256:cfba936e39931c286ca23add0ae546693db17d8b316e7cbc3891d26642d9b7e8
Ketersediaan: 0.2.2.0.9 atau lebih lama

Lanjut jelajahi

Perintah ini juga termasuk kategori pengembangan. Bandingkan untuk memilih operasi yang paling sesuai bagi tugas Anda.

Jelajahi semua perintah QZX