コンテンツにスキップ

出力スキーマ

この仕様は、pyscn が生成する JSON、YAML、CSV 出力の正確な構造を定義します。ここに記載されたすべてのフィールド名、型、およびセマンティクスは、同一メジャーバージョン内のパッチリリースにおいて安定しています。

安定性契約

保証 範囲
安定 フィールド名、フィールド型、フィールドセマンティクス、列挙値
変更の可能性あり オブジェクト内のフィールド順序、配列要素の順序、新規フィールドの追加
破壊的変更 フィールドの削除またはリネーム、フィールド型の変更、列挙値の削除

破壊的変更はメジャーバージョンアップ時のみ行われます。利用者は未知のフィールドを無視しなければなりません(MUST)。

トップレベル構造 (pyscn analyze)

JSON および YAML 出力は、domain/analyze.go で定義された AnalyzeResponse Go 構造体をシリアライズしたものです。トップレベルのキーは以下の通りです:

{
  "complexity":    { /* ComplexityResponse, present when enabled */ },
  "dead_code":     { /* DeadCodeResponse, present when enabled */ },
  "clone":         { /* CloneResponse, present when enabled */ },
  "cbo":           { /* CBOResponse, present when enabled */ },
  "lcom":          { /* LCOMResponse, present when enabled */ },
  "system":        { /* SystemAnalysisResponse, present when deps/arch enabled */ },
  "mock_data":     { /* MockDataResponse, present when enabled */ },
  "suggestions":   [ /* Suggestion array, omitted when empty */ ],
  "summary":       { /* AnalyzeSummary, always present */ },
  "generated_at":  "2026-04-14T10:18:23Z",
  "duration_ms":   2347,
  "version":       "0.14.0"
}
フィールド 説明 安定性
complexity object | absent 複雑度分析が実行された場合に存在します。 stable
dead_code object | absent デッドコード分析が実行された場合に存在します。 stable
clone object | absent クローン検出が実行された場合に存在します。 stable
cbo object | absent CBO 分析が実行された場合に存在します。 stable
lcom object | absent LCOM 分析が実行された場合に存在します。 stable
system object | absent 依存関係またはアーキテクチャ分析が実行された場合に存在します。 stable
mock_data object | absent モックデータ検出が実行された場合に存在します。 stable
suggestions array | absent 導出された提案。空の場合は省略されます。 stable
summary object 常に存在します。summary を参照してください。 stable
generated_at string (RFC 3339) 分析完了時刻。 stable
duration_ms integer 分析の合計所要時間(ミリ秒)。 stable
version string pyscn のセマンティックバージョン。 stable

summary オブジェクト

domain.AnalyzeSummary に対応します。対応するアナライザが無効の場合、すべての数値カウンタはデフォルト値 0 になります。すべてのフィールドは常に存在します。

ファイル統計

フィールド 説明
total_files integer 検出された Python ファイルの数。
analyzed_files integer 正常に分析されたファイルの数。
skipped_files integer 読み込みまたはパースに失敗して除外されたファイル。0 でない場合、以下のスコアは total_files の一部しかカバーしていません。

アナライザステータスフラグ

フィールド 説明
complexity_enabled boolean 複雑度分析が結果を生成した場合に true
dead_code_enabled boolean デッドコード分析が結果を生成した場合に true
clone_enabled boolean クローン検出が結果を生成した場合に true
cbo_enabled boolean CBO 分析が結果を生成した場合に true
lcom_enabled boolean LCOM 分析が結果を生成した場合に true
deps_enabled boolean 依存関係分析が結果を生成した場合に true
arch_enabled boolean アーキテクチャ検証が結果を生成した場合に true
mock_data_enabled boolean モックデータ検出が結果を生成した場合に true

複雑度メトリクス

フィールド 説明
total_functions integer 分析された関数の合計数。
total_class_scopes integer 分析されたクラス実行スコープ数。
average_complexity number サイクロマティック複雑度の平均値。関数がない場合は 0
high_complexity_count integer 複雑度が 10 を超える関数の数(中閾値)。
max_class_complexity integer クラススコープの最大サイクロマティック複雑度。
max_class_cognitive_complexity integer クラススコープの最大認知的複雑度。
max_class_nesting_depth integer クラススコープの最大ネスト深度。
high_complexity_class_scope_count integer 高リスクに分類されたクラススコープ数。

デッドコードメトリクス

フィールド 説明
dead_code_count integer 検出結果の合計数。
critical_dead_code integer 重大度 critical の検出結果。
warning_dead_code integer 重大度 warning の検出結果。
info_dead_code integer 重大度 info の検出結果。

クローンメトリクス

フィールド 説明
total_clones integer クローンとして識別された個別のコード断片。
clone_pairs integer クローンペアの数。
clone_groups integer クローングループの数。
code_duplication_percentage number 推定重複率、0100

CBO メトリクス

フィールド 説明
cbo_classes integer 分析されたクラスの合計数。
high_coupling_classes integer CBO > 7 のクラス。
medium_coupling_classes integer 3 < CBO ≤ 7 のクラス。
average_coupling number CBO の平均値。

LCOM メトリクス

フィールド 説明
lcom_classes integer 分析されたクラスの合計数。
high_lcom_classes integer LCOM4 > 5 のクラス。
medium_lcom_classes integer 2 < LCOM4 ≤ 5 のクラス。
average_lcom number LCOM4 の平均値。

依存関係メトリクス

フィールド 説明
deps_total_modules integer 分析されたモジュールの合計数。
deps_modules_in_cycles integer 少なくとも1つの循環依存に関与しているモジュール。
deps_max_depth integer 最長の依存チェーンの長さ。
deps_main_sequence_deviation number Martin のメインシーケンスからの平均距離、01

アーキテクチャメトリクス

フィールド 説明
arch_compliance number アーキテクチャ準拠率、01。重大度重み付き(error × 5 + warning × 1)。分子は system.ArchitectureAnalysis.WeightedViolations を参照。

モックデータメトリクス

フィールド 説明
mock_data_count integer モックデータ検出結果の合計数。
mock_data_error_count integer 重大度 error の検出結果。
mock_data_warning_count integer 重大度 warning の検出結果。
mock_data_info_count integer 重大度 info の検出結果。

ヘルススコアリング

フィールド 説明
health_score integer 総合スコア、0100ヘルススコア を参照。
grade string レターグレード。ABCDFN/A のいずれか。
complexity_score integer カテゴリ別スコア、0100
dead_code_score integer カテゴリ別スコア、0100
duplication_score integer カテゴリ別スコア、0100
coupling_score integer カテゴリ別スコア、0100
cohesion_score integer カテゴリ別スコア、0100
dependency_score integer カテゴリ別スコア、0100
architecture_score integer カテゴリ別スコア、0100

complexity オブジェクト

domain.ComplexityResponse に対応します。

{
  "functions": [ /* FunctionComplexity array */ ],
  "class_scopes": [ /* FunctionComplexity array; omitted when empty */ ],
  "summary": { /* ComplexitySummary */ },
  "raw_metrics": [ /* RawMetrics array, present when computed */ ],
  "raw_metrics_summary": { /* RawMetricsSummary, present when computed */ },
  "warnings": [ "..." ],
  "errors": [ "..." ],
  "generated_at": "2026-04-14T10:18:23Z",
  "version": "0.14.0",
  "config": null
}

functions[] および class_scopes[] 要素 (FunctionComplexity)

フィールド 説明
name string 修飾されたスコープ名。モジュールレベルのコードは <module>
scope_kind string 必須の実行所有者:modulefunctionclass のいずれか。
file_path string ソースファイルのパス。
start_line integer 1始まりの開始行。
start_column integer 0始まりの開始列。
end_line integer 1始まりの終了行。
metrics object ComplexityMetrics を参照。
risk_level string lowmediumhigh のいずれか。

ComplexityMetrics オブジェクト

フィールド 説明
complexity integer McCabe サイクロマティック複雑度。
cognitive_complexity integer 認知的複雑度(SonarQube スタイル)。
nodes integer CFG ノード数。
edges integer CFG エッジ数。
nesting_depth integer 最大ネスト深度。
if_statements integer if 文の数。
loop_statements integer for/while ループの数。
exception_handlers integer except 節の数。
switch_cases integer match ケースの数(Python 3.10+)。

summary オブジェクト (ComplexitySummary)

フィールド 説明
total_functions integer 分析されたモジュールおよび関数スコープの合計数。
total_class_scopes integer 分析された実行可能なクラススイートの合計数。
functions_parsed integer 非推奨。常に total_functions と同じ値。互換性のために残しており、将来削除されます。
average_complexity number モジュールおよび関数スコープの complexity の算術平均。
average_cognitive_complexity number モジュールおよび関数スコープの cognitive_complexity の算術平均。
average_nesting_depth number モジュールおよび関数スコープの nesting_depth の算術平均。
max_complexity integer モジュールおよび関数スコープの最大複雑度。
min_complexity integer モジュールおよび関数スコープの最小複雑度。
max_class_complexity integer クラススイートの最大サイクロマティック複雑度。
max_class_cognitive_complexity integer クラススイートの最大認知的複雑度。
max_class_nesting_depth integer クラススイートの最大ネスト深度。
high_risk_class_scopes integer 高リスクに分類されたクラススイート数。
files_analyzed integer パースに成功し、上記のメトリクスに寄与したファイル。
total_files integer パース成否によらず、リクエストが対象としたファイル。
skipped_files integer 読み込みまたはパースに失敗して除外されたファイル。その内容は上記すべてのメトリクスに含まれません。
low_risk_functions integer risk_level = low のモジュールおよび関数スコープ。
medium_risk_functions integer risk_level = medium のモジュールおよび関数スコープ。
high_risk_functions integer risk_level = high のモジュールおよび関数スコープ。
complexity_distribution object 関数のみを対象とし、複雑度バケット(string)からカウント(integer)へのヒストグラム、または null

クラススコープのメトリクスは加算的です。クラススコープを追加しても、従来の関数コレクション、件数、平均、極値、分布、モジュール・ディレクトリ集計、ヘルススコアは変わりません。

raw_metrics[] 要素 (RawMetrics)

フィールド 説明
file_path string ソースファイルのパス。
sloc integer ソースコード行数(空行・コメント行を除く)。
lloc integer 論理コード行数。
comment_lines integer コメントを含む行数。
docstring_lines integer docstring 内の行数。
blank_lines integer 空白行または空行。
total_lines integer 物理行の合計数。
comment_ratio number (comment_lines + docstring_lines) / total_lines01

dead_code オブジェクト

domain.DeadCodeResponse に対応します。全体を通して snake_case のフィールド名を使用します。

{
  "files": [ /* FileDeadCode array */ ],
  "summary": { /* DeadCodeSummary */ },
  "warnings": null,
  "errors": null,
  "generated_at": "",
  "version": "",
  "config": null
}

files[] 要素 (FileDeadCode)

フィールド 説明
file_path string ソースファイルのパス。
functions array 関数ごとの結果。既存フィールドで、関数のみ。
class_scopes array | absent 実行可能なクラススイートの結果。functions と同じ行モデル。
total_findings integer このファイルの関数とクラススコープの検出結果合計。
total_functions integer 分析された関数数。既存フィールドで、関数のみ。
affected_functions integer 検出結果がある関数数。既存フィールドで、関数のみ。
total_class_scopes integer 分析された実行可能なクラススイート数。
affected_class_scopes integer 検出結果がある実行可能なクラススイート数。
dead_code_ratio number 両スコープコレクションのデッドブロック / 全ブロック、01

files[].functions[] および files[].class_scopes[] 要素 (FunctionDeadCode)

フィールド 説明
name string 関数名またはクラス名。
scope_kind string 必須の実行所有者:functions では functionclass_scopes では class
file_path string ソースファイルのパス。
findings array この実行スコープ内の検出結果(下記参照)。
total_blocks integer このスコープ内の CFG ブロックの合計数。
dead_blocks integer 到達不能な CFG ブロック。
reachable_ratio number (total_blocks - dead_blocks) / total_blocks01
critical_count integer 重大度 critical の検出結果。
warning_count integer 重大度 warning の検出結果。
info_count integer 重大度 info の検出結果。

findings[] 要素 (DeadCodeFinding)

フィールド 説明
location object DeadCodeLocation を参照。
function_name string 包含する実行スコープ名(従来のフィールド名)。
scope_kind string 必須の実行所有者:function または class
code string デッドコードのソースコード断片。
reason string 分類 — 下記の列挙を参照。
severity string criticalwarninginfo のいずれか。
description string 人間が読める説明。
context array of string | absent 周囲のソース行。--show-context 指定時に存在。
block_id string | absent CFG ブロック識別子。

reason 列挙:

意味
after_return return 文の後のコード。
after_break break 文の後のコード。
after_continue continue 文の後のコード。
after_raise raise 文の後のコード。
unreachable_branch 到達されない条件分岐。

DeadCodeLocation オブジェクト

フィールド 説明
file_path string ソースファイルのパス。
start_line integer 1始まりの開始行。
end_line integer 1始まりの終了行。
start_column integer 0始まりの開始列。
end_column integer 0始まりの終了列。

summary オブジェクト (DeadCodeSummary)

フィールド 説明
total_files integer 分析されたファイル数。
total_functions integer 分析された関数数。
total_findings integer 全ファイルの関数とクラススコープの検出結果合計。
files_with_dead_code integer 少なくとも1つの検出結果があるファイル。
functions_with_dead_code integer 少なくとも1つの検出結果がある関数。
total_class_scopes integer 分析された実行可能なクラススイート数。
class_scopes_with_dead_code integer 少なくとも1つの検出結果があるクラススイート。
critical_findings integer 重大度 critical の検出結果。
warning_findings integer 重大度 warning の検出結果。
info_findings integer 重大度 info の検出結果。
findings_by_reason object | null reason 値をキーとしたヒストグラム。
total_blocks integer 関数とクラススコープの CFG ブロック総数。
dead_blocks integer 両コレクションの到達不能 CFG ブロック総数。
overall_dead_ratio number dead_blocks / total_blocks01

clone オブジェクト

domain.CloneResponse に対応します。全体を通して snake_case のフィールド名を使用します。

{
  "clones": [ /* Clone array, or null */ ],
  "clone_pairs": [ /* ClonePair array, or null */ ],
  "clone_groups": [ /* CloneGroup array, or null */ ],
  "statistics": { /* CloneStatistics */ },
  "duration_ms": 123,
  "success": true,
  "error": ""
}

clones[] 要素 (Clone)

フィールド 説明
id integer レスポンス内で一意のクローン識別子。
type integer 整数値のクローンタイプ: 123、または 4
location object CloneLocation を参照。
content string 生のソーステキスト。--show-content 設定時のみ存在。
hash string フィンガープリントハッシュ(アルゴリズムはクローンタイプに依存)。
size integer AST ノード数。
line_count integer 断片の行数。
complexity integer 断片のサイクロマティック複雑度。

type 列挙(整数値):

意味
1 Type-1: 空白/コメントを除いて同一。
2 Type-2: 構文的に同一、識別子/リテラルが異なる。
3 Type-3: 変更を伴う構造的類似。
4 Type-4: 意味的に等価、構文的に異なる。

CloneLocation オブジェクト

フィールド 説明
file_path string ソースファイルのパス。
start_line integer 1始まりの開始行。
end_line integer 1始まりの終了行。
start_col integer 0始まりの開始列。
end_col integer 0始まりの終了列。

clone_pairs[] 要素 (ClonePair)

フィールド 説明
id integer ペア識別子。
clone1 object 1つ目のクローン(Clone オブジェクト)。
clone2 object 2つ目のクローン(Clone オブジェクト)。
similarity number 類似度スコア、01
distance number ツリー編集距離(Type-3)、それ以外は 0
type integer クローンタイプ(clones[].type と同じ列挙)。
confidence number 検出器の信頼度、01

clone_groups[] 要素 (CloneGroup)

フィールド 説明
id integer グループ識別子。
clones array メンバーの Clone オブジェクト。
type integer 支配的なクローンタイプ。
similarity number 代表的な類似度、01
size integer メンバー数(len(clones))。

statistics オブジェクト (CloneStatistics)

フィールド 説明
total_fragments integer 抽出されたすべての断片(関数、クラスなど)。
total_clones integer クローンとして分類された断片。
total_clone_pairs integer 検出されたペアの数。
total_clone_groups integer グループの数。
clones_by_type object | null タイプラベル(Type-1Type-4)からカウントへのマップ。
average_similarity number ペア全体の平均類似度、01
lines_analyzed integer 考慮されたソース行の合計数。
nodes_analyzed integer 考慮された AST ノードの合計数。
files_analyzed integer 断片を提供した個別ファイル数。

その他の CloneResponse フィールド:

フィールド 説明
duration_ms integer クローン検出の所要時間(ミリ秒)。
success boolean 正常完了時に true
error string | absent success=false の場合のエラーメッセージ。
errors array | absent ファイル単位の失敗。ここに列挙されたファイルは実行自体は成功した上でスキップされたもので、その内容は statistics に含まれません。

cbo オブジェクト

domain.CBOResponse に対応します。

{
  "classes": [ /* ClassCoupling array */ ],
  "summary": { /* CBOSummary */ },
  "warnings": null,
  "errors": null,
  "generated_at": "",
  "version": "",
  "config": null
}

classes[] 要素 (ClassCoupling)

フィールド 説明
name string クラス名。
file_path string ソースファイルのパス。
start_line integer 1始まりの開始行。
end_line integer 1始まりの終了行。
metrics object CBOMetrics を参照。
risk_level string lowmediumhigh のいずれか。
is_abstract boolean クラスが抽象クラスの場合に true
base_classes array of string | null 直接の基底クラス。

CBOMetrics オブジェクト

フィールド 説明
coupling_count integer CBO 値: このクラスが依存する個別クラスの数。
inheritance_dependencies integer 基底クラスからの依存。
type_hint_dependencies integer 型アノテーションからの依存。
instantiation_dependencies integer オブジェクト生成からの依存。
attribute_access_dependencies integer メソッド呼び出しおよび属性アクセスからの依存。
import_dependencies integer 明示的インポートからの依存。
dependent_classes array of string | null 結合しているクラスの名前。

summary オブジェクト (CBOSummary)

フィールド 説明
total_classes integer 分析されたクラスの合計数。
average_cbo number CBO の平均値。
max_cbo integer 観測された最大 CBO。
min_cbo integer 観測された最小 CBO。
classes_analyzed integer 有効なメトリクスを持つクラス。
files_analyzed integer 少なくとも1つのクラスを含むファイル。
low_risk_classes integer CBO ≤ 低閾値(デフォルト 3)のクラス。
medium_risk_classes integer 低 < CBO ≤ 中閾値のクラス。
high_risk_classes integer CBO > 中閾値(デフォルト 7)のクラス。
cbo_distribution object | null バケットラベルからカウントへのヒストグラム。
most_coupled_classes array | null CBO 上位10クラス(ClassCoupling)。
most_depended_upon_classes array of string | null 被依存度が最も高いクラス。

lcom オブジェクト

domain.LCOMResponse に対応します。

{
  "classes": [ /* ClassCohesion array */ ],
  "summary": { /* LCOMSummary */ },
  "warnings": null,
  "errors": null,
  "generated_at": "",
  "version": "",
  "config": null
}

classes[] 要素 (ClassCohesion)

フィールド 説明
name string クラス名。
file_path string ソースファイルのパス。
start_line integer 1始まりの開始行。
end_line integer 1始まりの終了行。
metrics object LCOMMetrics を参照。
risk_level string lowmediumhigh のいずれか。

LCOMMetrics オブジェクト

フィールド 説明
lcom4 integer メソッド-変数グラフの連結成分数。
total_methods integer クラス内の全メソッド数。
excluded_methods integer LCOM4 のグラフから除外されたメソッド(@classmethod@staticmethod@abstractmethod、およびコンストラクタ __init____new____post_init__)。
instance_variables integer アクセスされた個別の self.x 変数の数。
method_groups array of array of string | null 連結成分ごとにグループ化されたメソッド名。

summary オブジェクト (LCOMSummary)

フィールド 説明
total_classes integer 分析されたクラス数。
average_lcom number LCOM4 の平均値。
max_lcom integer 観測された最大 LCOM4。
min_lcom integer 観測された最小 LCOM4。
classes_analyzed integer 有効なメトリクスを持つクラス。
files_analyzed integer 少なくとも1つのクラスを含むファイル。
low_risk_classes integer LCOM4 ≤ 低閾値(デフォルト 2)のクラス。
medium_risk_classes integer 低 < LCOM4 ≤ 中閾値のクラス。
high_risk_classes integer LCOM4 > 中閾値(デフォルト 5)のクラス。
lcom_distribution object | null バケットラベルからカウントへのヒストグラム。
least_cohesive_classes array | null LCOM4 上位10クラス(ClassCohesion)。

system オブジェクト

domain.SystemAnalysisResponse に対応します。

{
  "dependency_analysis":   { /* DependencyAnalysisResult, or null */ },
  "architecture_analysis": { /* ArchitectureAnalysisResult, or null */ },
  "summary":              { /* SystemAnalysisSummary */ },
  "issues":               [ /* SystemIssue array */ ],
  "recommendations":      [ /* SystemRecommendation array */ ],
  "warnings":             [ ],
  "errors":               [ ],
  "generated_at":          "0001-01-01T00:00:00Z",
  "duration":             0,
  "version":              "",
  "config":               null
}

summary オブジェクト (SystemAnalysisSummary)

フィールド 説明
total_modules integer 分析されたモジュールの合計数。
total_packages integer パッケージの合計数。
total_dependencies integer 依存関係エッジの合計数。
project_root string プロジェクトのルートディレクトリ。
overall_quality_score number 総合品質スコア、0100
maintainability_score number 保守性インデックスの平均値。
architecture_score number アーキテクチャ準拠スコア。
modularity_score number システムのモジュール性スコア。
technical_debt_hours number 推定技術的負債の合計(時間単位)。
average_coupling number モジュール結合度の平均値。
average_instability number 不安定性 (I) の平均値。
cyclic_dependencies integer 循環依存に関与するモジュール。
architecture_violations integer アーキテクチャルール違反の数。
high_risk_modules integer 高リスクとフラグされたモジュール。
critical_issues integer 重大な問題の数。
refactoring_candidates integer リファクタリングが必要なモジュール。
architecture_improvements integer 提案されたアーキテクチャ改善。

dependency_analysis オブジェクト

フィールド 説明
total_modules integer 依存関係グラフ内のモジュールの合計数。
total_dependencies integer エッジの合計数。
root_modules array of string 外向き依存のないモジュール。
leaf_modules array of string 内向き依存のないモジュール。
module_metrics object モジュール名から ModuleDependencyMetrics へのマップ。
dependency_matrix object モジュールからモジュールから boolean へのマップ。
circular_dependencies object 循環検出結果。Cycles(array)と TotalCycles(integer)を含む。
coupling_analysis object モジュールごとの結合度メトリクス: CaCeInstabilityAbstractnessDistance
longest_chains array DependencyPath オブジェクトの配列。
max_depth integer 最大依存深度。

ModuleDependencyMetrics オブジェクト

フィールド 説明
module_name string 完全修飾モジュール名。
package string 親パッケージ。
file_path string ソースファイルのパス。
is_package boolean パッケージ(__init__.py あり)の場合に true
lines_of_code integer コードの合計行数。
function_count integer 関数の数。
class_count integer クラスの数。
abstract_class_count integer 抽象クラスの数。
public_interface array of string __all__ またはトップレベルのパブリック名。
afferent_coupling integer Ca — このモジュールに依存するモジュール。
efferent_coupling integer Ce — このモジュールが依存するモジュール。
instability number I = Ce / (Ca + Ce)01
abstractness number A — 抽象クラス / 全クラス、01
distance number D = | A + I - 1 |01。メインシーケンスからの距離。
maintainability number 保守性インデックス、0100
technical_debt number 推定技術的負債(時間単位)。
risk_level string lowmediumhigh のいずれか。
direct_dependencies array of string 直接依存。
transitive_dependencies array of string すべての推移的依存。
dependents array of string このモジュールに依存するモジュール。

CircularDependencyAnalysis オブジェクト

フィールド 説明
has_circular_dependencies boolean 循環が存在する場合に true
total_cycles integer 循環の数。
total_modules_in_cycles integer 循環に関与するモジュール。
circular_dependencies array CircularDependency オブジェクトの配列。
cycle_breaking_suggestions array of string 循環を解消するための提案。
core_infrastructure array of string 複数の循環に出現するモジュール。

CircularDependency.Severity 列挙: lowmediumhighcritical

coupling_analysis オブジェクト

フィールド 説明
average_coupling number モジュール全体の平均結合度。
coupling_distribution object 結合度値(integer キー)からカウントへのマップ。
highly_coupled_modules array of string 高結合度のモジュール。
loosely_coupled_modules array of string 低結合度のモジュール。
average_instability number 平均不安定性。
stable_modules array of string 低不安定性のモジュール。
instable_modules array of string 高不安定性のモジュール。
main_sequence_deviation number メインシーケンスからの平均距離、01
zone_of_pain array of string 安定かつ具象のモジュール。
zone_of_uselessness array of string 不安定かつ抽象のモジュール。
main_sequence array of string 適切に配置されたモジュール。

architecture_analysis オブジェクト

フィールド 説明
compliance_score number 準拠スコア、01max(0, 1 - WeightedViolations / TotalRules) で計算。ルール未評価時は 1.0
total_violations integer 違反の生カウント(Violations 配列の要素数と一致)。
weighted_violations integer ComplianceScore の分子に用いる重み付き違反数:error × 5 + warning × 1
total_rules integer 評価されたルール呼び出しの合計数(ComplianceScore の分母)。
layer_analysis object | null レイヤー分析結果。
cohesion_analysis object | null パッケージ凝集度分析。
responsibility_analysis object | null SRP 違反分析。
violations array ArchitectureViolation オブジェクトの配列。
severity_breakdown object 重大度からカウントへのマップ。
recommendations array ArchitectureRecommendation オブジェクトの配列。
refactoring_targets array of string リファクタリングが必要なモジュール。

ArchitectureViolation.Type 列挙: layercyclecouplingresponsibilitycohesion

ArchitectureViolation.Severity 列挙: infowarningerrorcritical

suggestions 配列

Suggestion オブジェクトの配列です。snake_case のフィールド名を使用します。

フィールド 必須 説明
category string yes 下記の列挙を参照。
severity string yes criticalwarninginfo のいずれか。
effort string yes easymoderatehard のいずれか。
title string yes 短い人間が読めるタイトル。
description string yes 完全な説明。
steps array of string no 実行可能な手順。空の場合は省略。
file_path string no ソースファイル参照。
function string no 関数名参照。
class_name string no クラス名参照。
start_line integer no 1始まりの行参照。0 の場合は省略。
metric_value string no 観測されたメトリクス値(文字列)。
threshold string no 閾値(文字列)。

category 列挙: complexitydead_codeclonecouplingcohesiondependencyarchitecture

提案は優先度(重大度 x 労力)でソートされます。正確なソート関数については domain/suggestion.go を参照してください。

CSV スキーマ

CSV 出力は Go の encoding/csv パッケージを使用し、RFC 4180 に準拠したクォートで書き込まれます。

pyscn analyze --csv

サマリーのみです。2列構成。リテラル UTF-8 文字列、型アノテーションはありません。

説明
Metric string メトリクス名。
Value string メトリクス値(文字列)。

行(この固定順序で出力):

Metric,Value
Health Score,<integer>
Grade,<A|B|C|D|F|N/A>
Total Files,<integer>
Analyzed Files,<integer>
Average Complexity,<float with 2 decimals>
High Complexity Count,<integer>
Dead Code Count,<integer>
Critical Dead Code,<integer>
Unique Fragments,<integer>
Clone Groups,<integer>
Code Duplication,<float with 2 decimals>
Total Classes Analyzed,<integer>
High Coupling (CBO) Classes,<integer>
Average CBO,<float with 2 decimals>

pyscn は現在、CLI を通じてアナライザごとの CSV スキーマを公開していません。--csv は上記のサマリーのみを生成します。検出結果の詳細については、--json または --yaml を使用してください。

タイムスタンプとバージョニング

フィールド フォーマット 備考
generated_at RFC 3339 (ISO 8601) time.Time のシリアライズ。サブ秒精度やタイムゾーンオフセットを含む場合があります。
duration_ms integer(ミリ秒) 実時間による分析所要時間。
version string(セマンティックバージョン) pyscn のリリースバージョン、例: "0.14.0"

各フォーマットの呼び出し方

pyscn analyze--json--yaml--csv--html(デフォルト)のいずれかを受け付けます。--format フラグはなく、個別の complexity / deadcode / clone / deps サブコマンドもありません。単一のアナライザを実行するには --select を使用してください。

pyscn analyze --json src/
pyscn analyze --yaml src/
pyscn analyze --csv  src/
pyscn analyze --html src/    # default
pyscn analyze --json --select complexity src/
pyscn analyze --csv  --select deadcode   src/
pyscn analyze --yaml --select clones     src/

出力ファイルは .pyscn/reports/ に生成されます。パスとファイル名の詳細については 出力フォーマット を参照してください。

関連ドキュメント