メインコンテンツへ移動

開発 · コマンドリファレンス

qzx scaffoldPython

機能

Python プログラムの基本構成を作成します。

コマンドの成熟度: Alpha

実際の利用とフィードバックに使えますが、インターフェースと動作はまだ変更される可能性があります。 これは現在の開発チェックアウトに対する評価です。今後の各不変リリースタグには、そのバージョンに含まれた正確な評価が保存されます。 PyPI 0.2.2.0.15 で利用できます。ドキュメントは alpha チェックアウト 0.2.2.0.15 に対応しています。

動作と組み込み保護

実行モードでは指定した変更を適用します

この操作は直接実行されます

必要に応じてネイティブツールを使用します

ネットワークを使わずに動作します

権限昇格なしで動作するよう設計されています

この安全分類は 2026-10-08 に Claude Opus 5.5 (Anthropic) が実装ダイジェスト sha256:207c52ef2cd531e5f2baa76ace2a972a547c1e9d6e642d4f89a1e983451345b6 と照合してレビューしました。

正確な構文

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

パラメータ

スワイプするか横スクロールバーを使って、すべての列を表示してください。

名前型必須既定値説明
project_namestrはい未宣言作成する Python プロジェクト名
pathstrいいえ"."プロジェクトを作成するパス (既定値: 現在のディレクトリ)
with_testsboolいいえtrueテスト構成 (pytest) を含めるかどうか
create_venvboolいいえfalse仮想環境を作成するかどうか

入力例

qzx scaffoldPython my_project

現在のディレクトリに "my_project" という新しい Python プロジェクトを作成

qzx scaffoldPython my_project /path/to/dir true true

指定ディレクトリにテストと仮想環境付きの新規 Python プロジェクトを作成

qzx scaffoldPython api_service . false

現在のディレクトリにテストなしで "api_service" という新しい Python プロジェクトを作成

完全な構造化ペイロードを取得するには --json を追加します: qzx scaffoldPython <project_name> [path] [with_tests] [create_venv] --json

代表的な出力例

この説明用 JSON は現在の実装が裏付ける結果コントラクトから生成されています。記録された実行だと主張せず、コマンドが返し得る内容を示します。値は入力、マシン、権限、オプションツールによって変わります。

例のコマンド: 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
}
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
}

エラーと制限

公開コントラクトでは失敗時に success=false と説明的な message が必要です。このカタログではまだコマンドごとのエラー分類を宣言していません。結果を確認し、存在しないコードを推測しないでください。

QZX は alpha 段階です。オプション依存関係、権限、ホスト機能によって結果が変わる場合があります。

証拠フロー: 隔離された使い捨て対象が必要。

証拠と出所

テスト
同じモジュール名の専用テストファイルは見つかりませんでしたが、テストカバレッジがまったくないことを示すものではありません。
ドキュメントチャネル
開発ドキュメント 0.2.2.0.15 · main · sha256:b91acee86268edb7cb018a94e089ff8e95835eda3f2cf08b39796c0ab9654693
提供状況
0.2.2.0.15 以前

さらに探す

これらのコマンドも 開発 カテゴリに属します。比較して、タスクに最適な操作を選んでください。

QZX の全コマンドを見る