Lewati ke konten utama

pengembangan · Referensi perintah

qzx addPythonDocstrings

Apa fungsinya

Pratinjau atau tambahkan docstring yang dihasilkan ke fungsi, metode, dan kelas dalam file 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

Pratinjau tersedia

Berfungsi tanpa memanggil program native

Berfungsi tanpa menggunakan jaringan

Dirancang untuk bekerja tanpa elevasi hak akses

QZX membuat arsip pemulihan sebelum perubahan nyata; gunakan --dangerously-bypass-approvals-and-sandbox/--yolo hanya jika Anda sengaja memilih untuk melewatinya.

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

Sintaks persis

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

Parameter

Geser atau gunakan bilah horizontal untuk melihat semua kolom.

NamaTipeWajibDefaultDeskripsi
file_pathstrYaTidak dideklarasikanJalur file Python yang akan diproses
stylestrTidak"google"Gaya dokumentasi (google, numpy, atau sphinx)
overwriteboolTidakfalseMenentukan apakah docstring yang ada akan ditimpa
dry_runboolTidaktrueMempratinjau perubahan tanpa mengubah file

Contoh input

qzx addPythonDocstrings myfile.py

Pratinjau template docstring gaya Google untuk myfile.py

qzx addPythonDocstrings myfile.py sphinx

Pratinjau template docstring gaya Sphinx untuk myfile.py

qzx addPythonDocstrings myfile.py --dry-run false

Buat cadangan myfile.py lalu tambahkan docstring gaya Google yang belum ada

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

Buat cadangan myfile.py lalu ganti docstring yang ada

Untuk mendapatkan payload terstruktur lengkap, tambahkan --json: qzx addPythonDocstrings <file_path> [style] [overwrite] [dry_run] --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 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"
}
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
        },
        "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
}

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

Kanal dokumentasi
Dokumentasi pengembangan 0.2.2.0.9 · main · sha256:cfba936e39931c286ca23add0ae546693db17d8b316e7cbc3891d26642d9b7e8
Ketersediaan
0.2.2.0.9 atau lebih lama

Lanjut jelajahi

Perintah terkait

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

Jelajahi semua perintah QZX