Skip to main content

Module types

Module types 

Source
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 analysis
  • coupling: Cross-module coupling analysis
  • interface: Public API extraction
  • purity: Function purity/effect analysis
  • temporal: Temporal constraint mining
  • behavioral: Pre/postcondition extraction
  • mutability: Variable/parameter mutation tracking
  • resources: Resource lifecycle analysis

Structs§

BehavioralReport
Full behavioral analysis report.
ClassBehavior
Behavioral analysis for a class.
ClassCohesion
Cohesion analysis result for a single class.
ClassInfo
Information about a public class.
ClassInvariant
Class invariant.
ClassMutability
Mutability analysis for a class.
CohesionReport
Full report from cohesion analysis.
CohesionSummary
Summary of cohesion analysis across multiple classes.
CollectionMutation
Collection mutation detected.
ComponentInfo
Information about a connected component in LCOM4 analysis.
ContextSuggestion
Suggestion for using context manager.
CouplingReport
Coupling analysis between two modules.
CrossCall
A single cross-module function call.
CrossCalls
Calls from one module to another.
DoubleCloseInfo
Information about a double-close issue.
ExceptionInfo
Information about an exception the function may raise.
FieldMutability
Field mutability for a class.
FilePurityReport
Purity report for a single file.
FunctionBehavior
Behavioral analysis for a single function.
FunctionInfo
Information about a public function.
FunctionMutability
Mutability analysis for a function.
FunctionPurity
Purity analysis result for a single function.
InterfaceInfo
Interface (public API) for a single file.
LeakInfo
Information about a potential resource leak.
MethodInfo
Information about a public method within a class.
MutabilityReport
Full mutability report.
MutabilitySummary
Summary of mutability analysis.
ParameterMutability
Mutability information for a function parameter.
Postcondition
A postcondition on function return.
Precondition
A precondition on a function parameter.
PurityReport
Full purity report (may include multiple files for directory analysis).
ResourceConstraint
LLM-ready constraint from resource analysis.
ResourceInfo
Information about a detected resource.
ResourceReport
Full resource analysis report.
ResourceSummary
Summary of resource analysis.
SideEffect
Side effect detected in function.
TemporalConstraint
A temporal constraint (before -> after sequence).
TemporalExample
Example location for a temporal constraint.
TemporalMetadata
Metadata about temporal mining.
TemporalReport
Full temporal constraint report.
Trigram
A trigram (3-method sequence).
UseAfterCloseInfo
Information about use-after-close issue.
VariableMutability
Mutability information for a variable.
YieldInfo
Information about yield values (for generators).

Enums§

CohesionVerdict
Verdict for cohesion analysis.
ConditionSource
Source of a pre/postcondition constraint.
Confidence
Confidence level for inferred patterns and analysis results.
CouplingVerdict
Coupling verdict based on score.
DocstringStyle
Documentation style detected in source code.
EffectType
Type of side effect detected in code.
OutputFormat
Output format for command results.