Expand description
Shared types for Pattern Analysis commands
This module defines all data types used across the patterns analysis commands. Types are designed for JSON serialization with serde.
§Commands Using These Types
cohesion: LCOM4 class cohesion analysiscoupling: Cross-module coupling analysisinterface: Public API extractionpurity: Function purity/effect analysistemporal: Temporal constraint miningbehavioral: Pre/postcondition extractionmutability: Variable/parameter mutation trackingresources: Resource lifecycle analysis
Structs§
- Behavioral
Report - Full behavioral analysis report.
- Class
Behavior - Behavioral analysis for a class.
- Class
Cohesion - Cohesion analysis result for a single class.
- Class
Info - Information about a public class.
- Class
Invariant - Class invariant.
- Class
Mutability - Mutability analysis for a class.
- Cohesion
Report - Full report from cohesion analysis.
- Cohesion
Summary - Summary of cohesion analysis across multiple classes.
- Collection
Mutation - Collection mutation detected.
- Component
Info - Information about a connected component in LCOM4 analysis.
- Context
Suggestion - Suggestion for using context manager.
- Coupling
Report - Coupling analysis between two modules.
- Cross
Call - A single cross-module function call.
- Cross
Calls - Calls from one module to another.
- Double
Close Info - Information about a double-close issue.
- Exception
Info - Information about an exception the function may raise.
- Field
Mutability - Field mutability for a class.
- File
Purity Report - Purity report for a single file.
- Function
Behavior - Behavioral analysis for a single function.
- Function
Info - Information about a public function.
- Function
Mutability - Mutability analysis for a function.
- Function
Purity - Purity analysis result for a single function.
- Interface
Info - Interface (public API) for a single file.
- Leak
Info - Information about a potential resource leak.
- Method
Info - Information about a public method within a class.
- Mutability
Report - Full mutability report.
- Mutability
Summary - Summary of mutability analysis.
- Parameter
Mutability - Mutability information for a function parameter.
- Postcondition
- A postcondition on function return.
- Precondition
- A precondition on a function parameter.
- Purity
Report - Full purity report (may include multiple files for directory analysis).
- Resource
Constraint - LLM-ready constraint from resource analysis.
- Resource
Info - Information about a detected resource.
- Resource
Report - Full resource analysis report.
- Resource
Summary - Summary of resource analysis.
- Side
Effect - Side effect detected in function.
- Temporal
Constraint - A temporal constraint (before -> after sequence).
- Temporal
Example - Example location for a temporal constraint.
- Temporal
Metadata - Metadata about temporal mining.
- Temporal
Report - Full temporal constraint report.
- Trigram
- A trigram (3-method sequence).
- UseAfter
Close Info - Information about use-after-close issue.
- Variable
Mutability - Mutability information for a variable.
- Yield
Info - Information about yield values (for generators).
Enums§
- Cohesion
Verdict - Verdict for cohesion analysis.
- Condition
Source - Source of a pre/postcondition constraint.
- Confidence
- Confidence level for inferred patterns and analysis results.
- Coupling
Verdict - Coupling verdict based on score.
- Docstring
Style - Documentation style detected in source code.
- Effect
Type - Type of side effect detected in code.
- Output
Format - Output format for command results.