出力形式¶
pyscn は分析結果を出力ディレクトリ内のファイルに書き込みます。すべての形式はパッチリリース間で安定したフィールドセマンティクスを共有します。
出力ディレクトリ¶
デフォルト: カレントワーキングディレクトリ配下の .pyscn/reports/。
.pyscn.toml で設定可能です:
ファイル名パターン¶
{command} は analyze（レポートを書き込む唯一の pyscn コマンド）です。タイムスタンプはローカル時刻です。既存のファイルが上書きされることはありません。
サポートされる形式¶
| 形式 | 拡張子 | フラグ | 仕様 |
|---|---|---|---|
| text | — | (ターミナル) | 人間が読みやすい形式、安定性保証なし |
| json | .json |
--json |
schemas.md |
| yaml | .yaml |
--yaml |
schemas.md |
| csv | .csv |
--csv |
schemas.md |
| html | .html |
--html (デフォルト) |
html-report.md |
text 形式はターミナル表示を目的としており、安定性の保証はありません。レイアウトはリリース間で変更される可能性があります。
安定性の保証¶
同一メジャーバージョン内のパッチおよびマイナーリリース間:
- 安定:
json,yaml,csvのフィールド名、型、セマンティクスの意味。 - 変更の可能性: 配列要素の順序、新しいフィールドの追加、新しいトップレベルセクションの追加、
textおよびhtmlの外観上の変更。 - 破壊的変更: メジャーバージョンアップに限定（フィールドの削除・名前変更、フィールド型の変更）。
サードパーティ連携では、未知のフィールドを無視し、オブジェクト内のフィールド順序に依存しないようにしてください。