tenets.models Package

Data models for the Tenets package.

This package contains all data models and structures used throughout the Tenets codebase, including analysis results, context management, tenets, and more.

MODULE	DESCRIPTION
analysis	Code analysis models (ImportInfo, ComplexityMetrics, FunctionInfo, etc.)
context	Context management models (PromptContext, ContextResult, SessionContext)
tenet	Tenet-related models (Tenet, TenetCollection, Priority, etc.)
summary	Summary models (FileSummary, ProjectSummary)
llm	LLM-related models (ModelPricing, ModelLimits)

Classes

AnalysisReportdataclass

Python

AnalysisReport(timestamp: datetime = datetime.now(), format: str = 'json', content: str = '', statistics: Dict[str, Any] = dict(), output_path: Optional[str] = None)

Report generated from analysis results.

Formatted output of analysis results for different consumers.

ATTRIBUTE	DESCRIPTION
timestamp	When report was generated TYPE:datetime
format	Report format (json, html, markdown, csv) TYPE:str
content	Report content TYPE:str
statistics	Analysis statistics TYPE:Dict[str, Any]
output_path	Where report was saved (if applicable) TYPE:Optional[str]

Attributes

timestampclass-attributeinstance-attribute

Python

timestamp: datetime = field(default_factory=now)

formatclass-attributeinstance-attribute

Python

format: str = 'json'

contentclass-attributeinstance-attribute

Python

content: str = ''

statisticsclass-attributeinstance-attribute

Python

statistics: Dict[str, Any] = field(default_factory=dict)

output_pathclass-attributeinstance-attribute

Python

output_path: Optional[str] = None

Functions

to_dict

Python

to_dict() -> Dict[str, Any]

Convert to dictionary representation.

RETURNS	DESCRIPTION
Dict[str, Any]	Dict containing report information

ClassInfodataclass

Python

ClassInfo(name: str, line_start: int = 0, line_end: int = 0, methods: List[FunctionInfo] = list(), base_classes: List[str] = list(), line: int = 0, decorators: List[str] = list(), docstring: Optional[str] = None, is_abstract: bool = False, metaclass: Optional[str] = None, attributes: List[Dict[str, Any]] = list(), end_line: int = 0, bases: List[str] = list(), fields: List[Dict[str, Any]] = list(), interfaces: List[str] = list(), visibility: Optional[str] = None, modifiers: List[str] = list(), generics: Optional[str] = None, inner_classes: List[str] = list(), struct_type: Optional[str] = None, is_public: bool = False, is_struct: bool = False, is_template: bool = False, is_exported: bool = False, properties: List[Dict[str, Any]] = list(), events: List[Dict[str, Any]] = list(), type_parameters: Optional[str] = None, constructor_params: List[Dict[str, Any]] = list(), mixins: List[str] = list(), included_modules: List[str] = list(), extended_modules: List[str] = list(), delegates: Dict[str, str] = dict(), companion_object: Optional[Dict[str, Any]] = dict(), nested_classes: List[Dict[str, Any]] = dict(), has_companion: bool = False, is_case_class: bool = False, is_data_class: bool = False, is_sealed: bool = False, is_enum: bool = False, is_inner: bool = False, is_value_class: bool = False, android_type: Optional[str] = None, traits_used: List[Dict[str, Any]] = list(), constants: List[Any] = list(), constructors: List[Dict[str, Any]] = list(), is_widget: bool = False, widget_type: Optional[str] = None, access_level: Optional[str] = None, is_open: bool = False, is_final: bool = False, superclass: Optional[str] = None, protocols: List[str] = list(), nested_types: List[Dict[str, Any]] = list(), ui_type: Optional[str] = None, is_inner_class: bool = False, is_singleton: bool = False, is_monobehaviour: bool = False, is_scriptable_object: bool = False, unity_methods: List[str] = list(), coroutines: List[str] = list())

Information about a class or similar construct.

Represents classes, structs, interfaces across languages.

ATTRIBUTE	DESCRIPTION
name	Class/struct/interface name TYPE:str
line_start	Starting line number TYPE:int
line_end	Ending line number TYPE:int
methods	List of methods in the class TYPE:List[FunctionInfo]
base_classes	List of base/parent class names TYPE:List[str]
line	Compatibility alias for line_start TYPE:int
decorators	Decorator names applied to the class TYPE:List[str]
docstring	Class docstring TYPE:Optional[str]
is_abstract	Whether class is abstract TYPE:bool
metaclass	Metaclass name TYPE:Optional[str]
attributes	Collected class attributes TYPE:List[Dict[str, Any]]
end_line	Compatibility alias for line_end TYPE:int
bases	Compatibility alias accepted by some analyzers/tests TYPE:List[str]

Attributes

nameinstance-attribute

Python

name: str

line_startclass-attributeinstance-attribute

Python

line_start: int = 0

line_endclass-attributeinstance-attribute

Python

line_end: int = 0

methodsclass-attributeinstance-attribute

Python

methods: List[FunctionInfo] = field(default_factory=list)

base_classesclass-attributeinstance-attribute

Python

base_classes: List[str] = field(default_factory=list)

lineclass-attributeinstance-attribute

Python

line: int = 0

decoratorsclass-attributeinstance-attribute

Python

decorators: List[str] = field(default_factory=list)

docstringclass-attributeinstance-attribute

Python

docstring: Optional[str] = None

is_abstractclass-attributeinstance-attribute

Python

is_abstract: bool = False

metaclassclass-attributeinstance-attribute

Python

metaclass: Optional[str] = None

attributesclass-attributeinstance-attribute

Python

attributes: List[Dict[str, Any]] = field(default_factory=list)

end_lineclass-attributeinstance-attribute

Python

end_line: int = 0

basesclass-attributeinstance-attribute

Python

bases: List[str] = field(default_factory=list)

fieldsclass-attributeinstance-attribute

Python

fields: List[Dict[str, Any]] = field(default_factory=list)

interfacesclass-attributeinstance-attribute

Python

interfaces: List[str] = field(default_factory=list)

visibilityclass-attributeinstance-attribute

Python

visibility: Optional[str] = None

modifiersclass-attributeinstance-attribute

Python

modifiers: List[str] = field(default_factory=list)

genericsclass-attributeinstance-attribute

Python

generics: Optional[str] = None

inner_classesclass-attributeinstance-attribute

Python

inner_classes: List[str] = field(default_factory=list)

struct_typeclass-attributeinstance-attribute

Python

struct_type: Optional[str] = None

is_publicclass-attributeinstance-attribute

Python

is_public: bool = False

is_structclass-attributeinstance-attribute

Python

is_struct: bool = False

is_templateclass-attributeinstance-attribute

Python

is_template: bool = False

is_exportedclass-attributeinstance-attribute

Python

is_exported: bool = False

propertiesclass-attributeinstance-attribute

Python

properties: List[Dict[str, Any]] = field(default_factory=list)

eventsclass-attributeinstance-attribute

Python

events: List[Dict[str, Any]] = field(default_factory=list)

type_parametersclass-attributeinstance-attribute

Python

type_parameters: Optional[str] = None

constructor_paramsclass-attributeinstance-attribute

Python

constructor_params: List[Dict[str, Any]] = field(default_factory=list)

mixinsclass-attributeinstance-attribute

Python

mixins: List[str] = field(default_factory=list)

included_modulesclass-attributeinstance-attribute

Python

included_modules: List[str] = field(default_factory=list)

extended_modulesclass-attributeinstance-attribute

Python

extended_modules: List[str] = field(default_factory=list)

delegatesclass-attributeinstance-attribute

Python

delegates: Dict[str, str] = field(default_factory=dict)

companion_objectclass-attributeinstance-attribute

Python

companion_object: Optional[Dict[str, Any]] = field(default_factory=dict)

nested_classesclass-attributeinstance-attribute

Python

nested_classes: List[Dict[str, Any]] = field(default_factory=dict)

has_companionclass-attributeinstance-attribute

Python

has_companion: bool = False

is_case_classclass-attributeinstance-attribute

Python

is_case_class: bool = False

is_data_classclass-attributeinstance-attribute

Python

is_data_class: bool = False

is_sealedclass-attributeinstance-attribute

Python

is_sealed: bool = False

is_enumclass-attributeinstance-attribute

Python

is_enum: bool = False

is_innerclass-attributeinstance-attribute

Python

is_inner: bool = False

is_value_classclass-attributeinstance-attribute

Python

is_value_class: bool = False

android_typeclass-attributeinstance-attribute

Python

android_type: Optional[str] = None

traits_usedclass-attributeinstance-attribute

Python

traits_used: List[Dict[str, Any]] = field(default_factory=list)

constantsclass-attributeinstance-attribute

Python

constants: List[Any] = field(default_factory=list)

constructorsclass-attributeinstance-attribute

Python

constructors: List[Dict[str, Any]] = field(default_factory=list)

is_widgetclass-attributeinstance-attribute

Python

is_widget: bool = False

widget_typeclass-attributeinstance-attribute

Python

widget_type: Optional[str] = None

access_levelclass-attributeinstance-attribute

Python

access_level: Optional[str] = None

is_openclass-attributeinstance-attribute

Python

is_open: bool = False

is_finalclass-attributeinstance-attribute

Python

is_final: bool = False

superclassclass-attributeinstance-attribute

Python

superclass: Optional[str] = None

protocolsclass-attributeinstance-attribute

Python

protocols: List[str] = field(default_factory=list)

nested_typesclass-attributeinstance-attribute

Python

nested_types: List[Dict[str, Any]] = field(default_factory=list)

ui_typeclass-attributeinstance-attribute

Python

ui_type: Optional[str] = None

is_inner_classclass-attributeinstance-attribute

Python

is_inner_class: bool = False

is_singletonclass-attributeinstance-attribute

Python

is_singleton: bool = False

is_monobehaviourclass-attributeinstance-attribute

Python

is_monobehaviour: bool = False

is_scriptable_objectclass-attributeinstance-attribute

Python

is_scriptable_object: bool = False

unity_methodsclass-attributeinstance-attribute

Python

unity_methods: List[str] = field(default_factory=list)

coroutinesclass-attributeinstance-attribute

Python

coroutines: List[str] = field(default_factory=list)

Functions

to_dict

Python

to_dict() -> Dict[str, Any]

Convert to dictionary representation.

RETURNS	DESCRIPTION
Dict[str, Any]	Dict containing class information with serialized methods

CodeStructuredataclass

Python

CodeStructure(classes: List[ClassInfo] = list(), functions: List[FunctionInfo] = list(), imports: List[ImportInfo] = list(), file_type: str = 'text', sections: List[Dict[str, Any]] = list(), variables: List[Dict[str, Any]] = list(), constants: List[str] = list(), todos: List[Dict[str, Any]] = list(), block_count: int = 0, indent_levels: Dict[str, Any] = dict(), type_aliases: List[Dict[str, Any]] = list(), namespace: Optional[str] = None, is_unity_script: bool = False, language_variant: Optional[str] = None, namespaces: List[Dict[str, Any]] = list(), templates: List[Dict[str, Any]] = list(), macros: List[Dict[str, Any]] = list(), unions: List[Dict[str, Any]] = list(), structs: List[Dict[str, Any]] = list(), operator_overloads: int = 0, uses_stl: bool = False, smart_pointers: List[str] = list(), lambda_count: int = 0, interfaces: List[Dict[str, Any]] = list(), types: List[Dict[str, Any]] = list(), enums: List[Dict[str, Any]] = list(), modules: List[Dict[str, Any]] = list(), framework: Optional[str] = None, package: Optional[str] = None, records: List[Dict[str, Any]] = list(), annotations: List[str] = list(), anonymous_classes_count: int = 0, components: List[Dict[str, Any]] = list(), is_library: bool = False, is_binary: bool = False, aliases: List[Dict[str, Any]] = list(), is_test: bool = False, traits: List[Dict[str, Any]] = list(), impl_blocks: List[Dict[str, Any]] = list(), statics: List[Dict[str, Any]] = list(), derives: List[str] = list(), unsafe_blocks: int = 0, async_functions: int = 0, test_functions: int = 0, bench_functions: int = 0, crate_type: Optional[str] = None, await_points: int = 0, unsafe_functions: int = 0, objects: List[Dict[str, Any]] = list(), scala_version: Optional[int] = None, given_instances: int = 0, using_clauses: int = 0, extension_methods: int = 0, extension_functions: int = 0, match_expressions: int = 0, case_statements: int = 0, for_comprehensions: int = 0, yield_expressions: int = 0, implicit_defs: int = 0, implicit_params: int = 0, lambda_expressions: int = 0, partial_functions: int = 0, is_android: bool = False, suspend_functions: int = 0, coroutine_launches: int = 0, flow_usage: int = 0, nullable_types: int = 0, null_assertions: int = 0, safe_calls: int = 0, elvis_operators: int = 0, scope_functions: int = 0, is_tool_script: bool = False, class_name: Optional[str] = None, parent_class: Optional[str] = None, godot_version: Optional[int] = None, signals: List[Dict[str, Any]] = list(), export_vars: List[Dict[str, Any]] = list(), onready_vars: List[Dict[str, Any]] = list(), setget_properties: List[Dict[str, Any]] = list(), node_references: int = 0, get_node_calls: int = 0, connect_calls: int = 0, emit_signal_calls: int = 0, is_custom_resource: bool = False, is_flutter: bool = False, mixins: List[Dict[str, Any]] = list(), extensions: List[Dict[str, Any]] = list(), typedefs: List[Dict[str, Any]] = list(), has_main: bool = False, is_test_file: bool = False, is_ios: bool = False, is_swiftui: bool = False, is_uikit: bool = False, protocols: List[Dict[str, Any]] = list(), actors: List[Dict[str, Any]] = list(), task_count: int = 0, await_count: int = 0, optional_count: int = 0, force_unwrap_count: int = 0, optional_chaining_count: int = 0, nil_coalescing_count: int = 0, guard_count: int = 0, if_let_count: int = 0, guard_let_count: int = 0, actor_count: int = 0, property_wrappers: int = 0, result_builders: int = 0, combine_publishers: int = 0, combine_operators: int = 0, swiftui_views: int = 0, view_modifiers: int = 0, body_count: int = 0, form_count: int = 0, input_count: int = 0, alt_texts: int = 0)

Represents the structure of a code file.

Contains organized information about code elements found in a file.

ATTRIBUTE	DESCRIPTION
classes	List of classes in the file TYPE:List[ClassInfo]
functions	List of standalone functions TYPE:List[FunctionInfo]
imports	List of import statements TYPE:List[ImportInfo]
file_type	Type of the file (e.g., script, module, package) TYPE:str
sections	List of sections or blocks in the code TYPE:List[Dict[str, Any]]
variables	List of variables used TYPE:List[Dict[str, Any]]
constants	List of constants TYPE:List[str]
todos	List of TODO comments or annotations TYPE:List[Dict[str, Any]]
block_count	Total number of code blocks TYPE:int
indent_levels	Indentation levels used in the code TYPE:Dict[str, Any]
type_aliases	List of type alias definitions (Python 3.10+) TYPE:List[Dict[str, Any]]

Attributes

classesclass-attributeinstance-attribute

Python

classes: List[ClassInfo] = field(default_factory=list)

functionsclass-attributeinstance-attribute

Python

functions: List[FunctionInfo] = field(default_factory=list)

importsclass-attributeinstance-attribute

Python

imports: List[ImportInfo] = field(default_factory=list)

file_typeclass-attributeinstance-attribute

Python

file_type: str = 'text'

sectionsclass-attributeinstance-attribute

Python

sections: List[Dict[str, Any]] = field(default_factory=list)

variablesclass-attributeinstance-attribute

Python

variables: List[Dict[str, Any]] = field(default_factory=list)

constantsclass-attributeinstance-attribute

Python

constants: List[str] = field(default_factory=list)

todosclass-attributeinstance-attribute

Python

todos: List[Dict[str, Any]] = field(default_factory=list)

block_countclass-attributeinstance-attribute

Python

block_count: int = 0

indent_levelsclass-attributeinstance-attribute

Python

indent_levels: Dict[str, Any] = field(default_factory=dict)

type_aliasesclass-attributeinstance-attribute

Python

type_aliases: List[Dict[str, Any]] = field(default_factory=list)

namespaceclass-attributeinstance-attribute

Python

namespace: Optional[str] = None

is_unity_scriptclass-attributeinstance-attribute

Python

is_unity_script: bool = False

language_variantclass-attributeinstance-attribute

Python

language_variant: Optional[str] = None

namespacesclass-attributeinstance-attribute

Python

namespaces: List[Dict[str, Any]] = field(default_factory=list)

templatesclass-attributeinstance-attribute

Python

templates: List[Dict[str, Any]] = field(default_factory=list)

macrosclass-attributeinstance-attribute

Python

macros: List[Dict[str, Any]] = field(default_factory=list)

unionsclass-attributeinstance-attribute

Python

unions: List[Dict[str, Any]] = field(default_factory=list)

structsclass-attributeinstance-attribute

Python

structs: List[Dict[str, Any]] = field(default_factory=list)

operator_overloadsclass-attributeinstance-attribute

Python

operator_overloads: int = 0

uses_stlclass-attributeinstance-attribute

Python

uses_stl: bool = False

smart_pointersclass-attributeinstance-attribute

Python

smart_pointers: List[str] = field(default_factory=list)

lambda_countclass-attributeinstance-attribute

Python

lambda_count: int = 0

interfacesclass-attributeinstance-attribute

Python

interfaces: List[Dict[str, Any]] = field(default_factory=list)

typesclass-attributeinstance-attribute

Python

types: List[Dict[str, Any]] = field(default_factory=list)

enumsclass-attributeinstance-attribute

Python

enums: List[Dict[str, Any]] = field(default_factory=list)

modulesclass-attributeinstance-attribute

Python

modules: List[Dict[str, Any]] = field(default_factory=list)

frameworkclass-attributeinstance-attribute

Python

framework: Optional[str] = None

packageclass-attributeinstance-attribute

Python

package: Optional[str] = None

recordsclass-attributeinstance-attribute

Python

records: List[Dict[str, Any]] = field(default_factory=list)

annotationsclass-attributeinstance-attribute

Python

annotations: List[str] = field(default_factory=list)

anonymous_classes_countclass-attributeinstance-attribute

Python

anonymous_classes_count: int = 0

componentsclass-attributeinstance-attribute

Python

components: List[Dict[str, Any]] = field(default_factory=list)

is_libraryclass-attributeinstance-attribute

Python

is_library: bool = False

is_binaryclass-attributeinstance-attribute

Python

is_binary: bool = False

aliasesclass-attributeinstance-attribute

Python

aliases: List[Dict[str, Any]] = field(default_factory=list)

is_testclass-attributeinstance-attribute

Python

is_test: bool = False

traitsclass-attributeinstance-attribute

Python

traits: List[Dict[str, Any]] = field(default_factory=list)

impl_blocksclass-attributeinstance-attribute

Python

impl_blocks: List[Dict[str, Any]] = field(default_factory=list)

staticsclass-attributeinstance-attribute

Python

statics: List[Dict[str, Any]] = field(default_factory=list)

derivesclass-attributeinstance-attribute

Python

derives: List[str] = field(default_factory=list)

unsafe_blocksclass-attributeinstance-attribute

Python

unsafe_blocks: int = 0

async_functionsclass-attributeinstance-attribute

Python

async_functions: int = 0

bench_functionsclass-attributeinstance-attribute

Python

bench_functions: int = 0

crate_typeclass-attributeinstance-attribute

Python

crate_type: Optional[str] = None

await_pointsclass-attributeinstance-attribute

Python

await_points: int = 0

unsafe_functionsclass-attributeinstance-attribute

Python

unsafe_functions: int = 0

objectsclass-attributeinstance-attribute

Python

objects: List[Dict[str, Any]] = field(default_factory=list)

scala_versionclass-attributeinstance-attribute

Python

scala_version: Optional[int] = None

given_instancesclass-attributeinstance-attribute

Python

given_instances: int = 0

using_clausesclass-attributeinstance-attribute

Python

using_clauses: int = 0

extension_methodsclass-attributeinstance-attribute

Python

extension_methods: int = 0

extension_functionsclass-attributeinstance-attribute

Python

extension_functions: int = 0

match_expressionsclass-attributeinstance-attribute

Python

match_expressions: int = 0

case_statementsclass-attributeinstance-attribute

Python

case_statements: int = 0

for_comprehensionsclass-attributeinstance-attribute

Python

for_comprehensions: int = 0

yield_expressionsclass-attributeinstance-attribute

Python

yield_expressions: int = 0

implicit_defsclass-attributeinstance-attribute

Python

implicit_defs: int = 0

implicit_paramsclass-attributeinstance-attribute

Python

implicit_params: int = 0

lambda_expressionsclass-attributeinstance-attribute

Python

lambda_expressions: int = 0

partial_functionsclass-attributeinstance-attribute

Python

partial_functions: int = 0

is_androidclass-attributeinstance-attribute

Python

is_android: bool = False

suspend_functionsclass-attributeinstance-attribute

Python

suspend_functions: int = 0

coroutine_launchesclass-attributeinstance-attribute

Python

coroutine_launches: int = 0

flow_usageclass-attributeinstance-attribute

Python

flow_usage: int = 0

nullable_typesclass-attributeinstance-attribute

Python

nullable_types: int = 0

null_assertionsclass-attributeinstance-attribute

Python

null_assertions: int = 0

safe_callsclass-attributeinstance-attribute

Python

safe_calls: int = 0

elvis_operatorsclass-attributeinstance-attribute

Python

elvis_operators: int = 0

scope_functionsclass-attributeinstance-attribute

Python

scope_functions: int = 0

is_tool_scriptclass-attributeinstance-attribute

Python

is_tool_script: bool = False

class_nameclass-attributeinstance-attribute

Python

class_name: Optional[str] = None

parent_classclass-attributeinstance-attribute

Python

parent_class: Optional[str] = None

godot_versionclass-attributeinstance-attribute

Python

godot_version: Optional[int] = None

signalsclass-attributeinstance-attribute

Python

signals: List[Dict[str, Any]] = field(default_factory=list)

export_varsclass-attributeinstance-attribute

Python

export_vars: List[Dict[str, Any]] = field(default_factory=list)

onready_varsclass-attributeinstance-attribute

Python

onready_vars: List[Dict[str, Any]] = field(default_factory=list)

setget_propertiesclass-attributeinstance-attribute

Python

setget_properties: List[Dict[str, Any]] = field(default_factory=list)

node_referencesclass-attributeinstance-attribute

Python

node_references: int = 0

get_node_callsclass-attributeinstance-attribute

Python

get_node_calls: int = 0

connect_callsclass-attributeinstance-attribute

Python

connect_calls: int = 0

emit_signal_callsclass-attributeinstance-attribute

Python

emit_signal_calls: int = 0

is_custom_resourceclass-attributeinstance-attribute

Python

is_custom_resource: bool = False

is_flutterclass-attributeinstance-attribute

Python

is_flutter: bool = False

mixinsclass-attributeinstance-attribute

Python

mixins: List[Dict[str, Any]] = field(default_factory=list)

extensionsclass-attributeinstance-attribute

Python

extensions: List[Dict[str, Any]] = field(default_factory=list)

typedefsclass-attributeinstance-attribute

Python

typedefs: List[Dict[str, Any]] = field(default_factory=list)

has_mainclass-attributeinstance-attribute

Python

has_main: bool = False

is_test_fileclass-attributeinstance-attribute

Python

is_test_file: bool = False

is_iosclass-attributeinstance-attribute

Python

is_ios: bool = False

is_swiftuiclass-attributeinstance-attribute

Python

is_swiftui: bool = False

is_uikitclass-attributeinstance-attribute

Python

is_uikit: bool = False

protocolsclass-attributeinstance-attribute

Python

protocols: List[Dict[str, Any]] = field(default_factory=list)

actorsclass-attributeinstance-attribute

Python

actors: List[Dict[str, Any]] = field(default_factory=list)

task_countclass-attributeinstance-attribute

Python

task_count: int = 0

await_countclass-attributeinstance-attribute

Python

await_count: int = 0

optional_countclass-attributeinstance-attribute

Python

optional_count: int = 0

force_unwrap_countclass-attributeinstance-attribute

Python

force_unwrap_count: int = 0

optional_chaining_countclass-attributeinstance-attribute

Python

optional_chaining_count: int = 0

nil_coalescing_countclass-attributeinstance-attribute

Python

nil_coalescing_count: int = 0

guard_countclass-attributeinstance-attribute

Python

guard_count: int = 0

if_let_countclass-attributeinstance-attribute

Python

if_let_count: int = 0

guard_let_countclass-attributeinstance-attribute

Python

guard_let_count: int = 0

actor_countclass-attributeinstance-attribute

Python

actor_count: int = 0

property_wrappersclass-attributeinstance-attribute

Python

property_wrappers: int = 0

result_buildersclass-attributeinstance-attribute

Python

result_builders: int = 0

combine_publishersclass-attributeinstance-attribute

Python

combine_publishers: int = 0

combine_operatorsclass-attributeinstance-attribute

Python

combine_operators: int = 0

swiftui_viewsclass-attributeinstance-attribute

Python

swiftui_views: int = 0

view_modifiersclass-attributeinstance-attribute

Python

view_modifiers: int = 0

body_countclass-attributeinstance-attribute

Python

body_count: int = 0

form_countclass-attributeinstance-attribute

Python

form_count: int = 0

input_countclass-attributeinstance-attribute

Python

input_count: int = 0

alt_textsclass-attributeinstance-attribute

Python

alt_texts: int = 0

Functions

to_dict

Python

to_dict() -> Dict[str, Any]

Convert to dictionary representation.

RETURNS	DESCRIPTION
Dict[str, Any]	Dict containing all structural information

ComplexityMetricsdataclass

Python

ComplexityMetrics(cyclomatic: int = 1, cognitive: int = 0, halstead_volume: float = 0.0, halstead_difficulty: float = 0.0, maintainability_index: float = 100.0, line_count: int = 0, function_count: int = 0, class_count: int = 0, max_depth: int = 0, comment_ratio: float = 0.0, code_lines: int = 0, comment_lines: int = 0, character_count: int = 0, key_count: int = 0, section_count: int = 0, tag_count: int = 0, header_count: int = 0, column_count: int = 0, row_count: int = 0, template_count: int = 0, template_specializations: int = 0, macro_count: int = 0, ifdef_count: int = 0, include_count: int = 0, new_count: int = 0, delete_count: int = 0, malloc_count: int = 0, free_count: int = 0, unique_ptr_count: int = 0, shared_ptr_count: int = 0, weak_ptr_count: int = 0, uses_raii: bool = False, memory_safety_score: float = 1.0, interface_count: int = 0, type_count: int = 0, enum_count: int = 0, record_count: int = 0, method_count: int = 0, try_blocks: int = 0, catch_blocks: int = 0, finally_blocks: int = 0, throws_declarations: int = 0, annotation_count: int = 0, extends_count: int = 0, implements_count: int = 0, lambda_count: int = 0, stream_operations: int = 0, unsafe_blocks: int = 0, unsafe_functions: int = 0, unsafe_traits: int = 0, unsafe_impl: int = 0, unsafe_score: int = 0, lifetime_annotations: int = 0, lifetime_bounds: int = 0, generic_types: int = 0, trait_bounds: int = 0, async_functions: int = 0, await_points: int = 0, result_types: int = 0, option_types: int = 0, unwrap_calls: int = 0, expect_calls: int = 0, question_marks: int = 0, macro_invocations: int = 0, derive_macros: int = 0, test_count: int = 0, bench_count: int = 0, assertion_count: int = 0, combine_operators: int = 0, task_count: int = 0, task_groups: int = 0, await_calls: int = 0, optional_types: int = 0, force_unwraps: int = 0, optional_chaining: int = 0, nil_coalescing: int = 0, guard_statements: int = 0, if_let_bindings: int = 0, guard_let_bindings: int = 0, published_wrappers: int = 0, combine_publishers: int = 0, combine_subscriptions: int = 0, trait_count: int = 0, object_count: int = 0, case_class_count: int = 0, match_expressions: int = 0, case_clauses: int = 0, pattern_guards: int = 0, higher_order_functions: int = 0, for_comprehensions: int = 0, partial_functions: int = 0, type_parameters: int = 0, variance_annotations: int = 0, type_aliases: int = 0, existential_types: int = 0, implicit_defs: int = 0, implicit_params: int = 0, implicit_conversions: int = 0, future_usage: int = 0, actor_usage: int = 0, async_await: int = 0, immutable_collections: int = 0, mutable_collections: int = 0, throw_statements: int = 0, option_usage: int = 0, either_usage: int = 0, try_usage: int = 0, signal_count: int = 0, export_count: int = 0, onready_count: int = 0, node_ref_count: int = 0, get_node_count: int = 0, connect_count: int = 0, emit_count: int = 0, lifecycle_count: int = 0, rpc_count: int = 0, typed_vars: int = 0, typed_funcs: int = 0, return_types: int = 0, has_csp: bool = False, has_integrity_checks: bool = False, has_https_links: int = 0, delegation_count: int = 0, lazy_properties: int = 0, observable_properties: int = 0, lateinit_count: int = 0)

Code complexity metrics for analysis.

Contains various complexity measurements used to assess code quality and maintainability.

ATTRIBUTE	DESCRIPTION
cyclomatic	McCabe cyclomatic complexity TYPE:int
cognitive	Cognitive complexity score TYPE:int
halstead_volume	Halstead volume metric TYPE:float
halstead_difficulty	Halstead difficulty metric TYPE:float
maintainability_index	Maintainability index (0-100) TYPE:float
line_count	Total number of lines TYPE:int
function_count	Number of functions TYPE:int
class_count	Number of classes TYPE:int
max_depth	Maximum nesting depth TYPE:int
comment_ratio	Ratio of comments to code TYPE:float
code_lines	Number of actual code lines TYPE:int
comment_lines	Number of comment lines TYPE:int
character_count	Total number of characters TYPE:int
key_count	Number of key/value pairs (for config files) TYPE:int
section_count	Number of sections (for structured files) TYPE:int
tag_count	Number of tags (for markup languages) TYPE:int
header_count	Number of headers (for document files) TYPE:int
column_count	Number of columns (for tabular data) TYPE:int
row_count	Number of rows (for tabular data) TYPE:int

Attributes

cyclomaticclass-attributeinstance-attribute

Python

cyclomatic: int = 1

cognitiveclass-attributeinstance-attribute

Python

cognitive: int = 0

halstead_volumeclass-attributeinstance-attribute

Python

halstead_volume: float = 0.0

halstead_difficultyclass-attributeinstance-attribute

Python

halstead_difficulty: float = 0.0

maintainability_indexclass-attributeinstance-attribute

Python

maintainability_index: float = 100.0

line_countclass-attributeinstance-attribute

Python

line_count: int = 0

function_countclass-attributeinstance-attribute

Python

function_count: int = 0

class_countclass-attributeinstance-attribute

Python

class_count: int = 0

max_depthclass-attributeinstance-attribute

Python

max_depth: int = 0

comment_ratioclass-attributeinstance-attribute

Python

comment_ratio: float = 0.0

code_linesclass-attributeinstance-attribute

Python

code_lines: int = 0

comment_linesclass-attributeinstance-attribute

Python

comment_lines: int = 0

character_countclass-attributeinstance-attribute

Python

character_count: int = 0

key_countclass-attributeinstance-attribute

Python

key_count: int = 0

section_countclass-attributeinstance-attribute

Python

section_count: int = 0

tag_countclass-attributeinstance-attribute

Python

tag_count: int = 0

header_countclass-attributeinstance-attribute

Python

header_count: int = 0

column_countclass-attributeinstance-attribute

Python

column_count: int = 0

row_countclass-attributeinstance-attribute

Python

row_count: int = 0

template_countclass-attributeinstance-attribute

Python

template_count: int = 0

template_specializationsclass-attributeinstance-attribute

Python

template_specializations: int = 0

macro_countclass-attributeinstance-attribute

Python

macro_count: int = 0

ifdef_countclass-attributeinstance-attribute

Python

ifdef_count: int = 0

include_countclass-attributeinstance-attribute

Python

include_count: int = 0

new_countclass-attributeinstance-attribute

Python

new_count: int = 0

delete_countclass-attributeinstance-attribute

Python

delete_count: int = 0

malloc_countclass-attributeinstance-attribute

Python

malloc_count: int = 0

free_countclass-attributeinstance-attribute

Python

free_count: int = 0

unique_ptr_countclass-attributeinstance-attribute

Python

unique_ptr_count: int = 0

shared_ptr_countclass-attributeinstance-attribute

Python

shared_ptr_count: int = 0

weak_ptr_countclass-attributeinstance-attribute

Python

weak_ptr_count: int = 0

uses_raiiclass-attributeinstance-attribute

Python

uses_raii: bool = False

memory_safety_scoreclass-attributeinstance-attribute

Python

memory_safety_score: float = 1.0

interface_countclass-attributeinstance-attribute

Python

interface_count: int = 0

type_countclass-attributeinstance-attribute

Python

type_count: int = 0

enum_countclass-attributeinstance-attribute

Python

enum_count: int = 0

record_countclass-attributeinstance-attribute

Python

record_count: int = 0

method_countclass-attributeinstance-attribute

Python

method_count: int = 0

try_blocksclass-attributeinstance-attribute

Python

try_blocks: int = 0

catch_blocksclass-attributeinstance-attribute

Python

catch_blocks: int = 0

finally_blocksclass-attributeinstance-attribute

Python

finally_blocks: int = 0

throws_declarationsclass-attributeinstance-attribute

Python

throws_declarations: int = 0

annotation_countclass-attributeinstance-attribute

Python

annotation_count: int = 0

extends_countclass-attributeinstance-attribute

Python

extends_count: int = 0

implements_countclass-attributeinstance-attribute

Python

implements_count: int = 0

lambda_countclass-attributeinstance-attribute

Python

lambda_count: int = 0

stream_operationsclass-attributeinstance-attribute

Python

stream_operations: int = 0

unsafe_blocksclass-attributeinstance-attribute

Python

unsafe_blocks: int = 0

unsafe_functionsclass-attributeinstance-attribute

Python

unsafe_functions: int = 0

unsafe_traitsclass-attributeinstance-attribute

Python

unsafe_traits: int = 0

unsafe_implclass-attributeinstance-attribute

Python

unsafe_impl: int = 0

unsafe_scoreclass-attributeinstance-attribute

Python

unsafe_score: int = 0

lifetime_annotationsclass-attributeinstance-attribute

Python

lifetime_annotations: int = 0

lifetime_boundsclass-attributeinstance-attribute

Python

lifetime_bounds: int = 0

generic_typesclass-attributeinstance-attribute

Python

generic_types: int = 0

trait_boundsclass-attributeinstance-attribute

Python

trait_bounds: int = 0

async_functionsclass-attributeinstance-attribute

Python

async_functions: int = 0

await_pointsclass-attributeinstance-attribute

Python

await_points: int = 0

result_typesclass-attributeinstance-attribute

Python

result_types: int = 0

option_typesclass-attributeinstance-attribute

Python

option_types: int = 0

unwrap_callsclass-attributeinstance-attribute

Python

unwrap_calls: int = 0

expect_callsclass-attributeinstance-attribute

Python

expect_calls: int = 0

question_marksclass-attributeinstance-attribute

Python

question_marks: int = 0

macro_invocationsclass-attributeinstance-attribute

Python

macro_invocations: int = 0

derive_macrosclass-attributeinstance-attribute

Python

derive_macros: int = 0

bench_countclass-attributeinstance-attribute

Python

bench_count: int = 0

assertion_countclass-attributeinstance-attribute

Python

assertion_count: int = 0

combine_operatorsclass-attributeinstance-attribute

Python

combine_operators: int = 0

task_countclass-attributeinstance-attribute

Python

task_count: int = 0

task_groupsclass-attributeinstance-attribute

Python

task_groups: int = 0

await_callsclass-attributeinstance-attribute

Python

await_calls: int = 0

optional_typesclass-attributeinstance-attribute

Python

optional_types: int = 0

force_unwrapsclass-attributeinstance-attribute

Python

force_unwraps: int = 0

optional_chainingclass-attributeinstance-attribute

Python

optional_chaining: int = 0

nil_coalescingclass-attributeinstance-attribute

Python

nil_coalescing: int = 0

guard_statementsclass-attributeinstance-attribute

Python

guard_statements: int = 0

if_let_bindingsclass-attributeinstance-attribute

Python

if_let_bindings: int = 0

guard_let_bindingsclass-attributeinstance-attribute

Python

guard_let_bindings: int = 0

published_wrappersclass-attributeinstance-attribute

Python

published_wrappers: int = 0

combine_publishersclass-attributeinstance-attribute

Python

combine_publishers: int = 0

combine_subscriptionsclass-attributeinstance-attribute

Python

combine_subscriptions: int = 0

trait_countclass-attributeinstance-attribute

Python

trait_count: int = 0

object_countclass-attributeinstance-attribute

Python

object_count: int = 0

case_class_countclass-attributeinstance-attribute

Python

case_class_count: int = 0

match_expressionsclass-attributeinstance-attribute

Python

match_expressions: int = 0

case_clausesclass-attributeinstance-attribute

Python

case_clauses: int = 0

pattern_guardsclass-attributeinstance-attribute

Python

pattern_guards: int = 0

higher_order_functionsclass-attributeinstance-attribute

Python

higher_order_functions: int = 0

for_comprehensionsclass-attributeinstance-attribute

Python

for_comprehensions: int = 0

partial_functionsclass-attributeinstance-attribute

Python

partial_functions: int = 0

type_parametersclass-attributeinstance-attribute

Python

type_parameters: int = 0

variance_annotationsclass-attributeinstance-attribute

Python

variance_annotations: int = 0

type_aliasesclass-attributeinstance-attribute

Python

type_aliases: int = 0

existential_typesclass-attributeinstance-attribute

Python

existential_types: int = 0

implicit_defsclass-attributeinstance-attribute

Python

implicit_defs: int = 0

implicit_paramsclass-attributeinstance-attribute

Python

implicit_params: int = 0

implicit_conversionsclass-attributeinstance-attribute

Python

implicit_conversions: int = 0

future_usageclass-attributeinstance-attribute

Python

future_usage: int = 0

actor_usageclass-attributeinstance-attribute

Python

actor_usage: int = 0

async_awaitclass-attributeinstance-attribute

Python

async_await: int = 0

immutable_collectionsclass-attributeinstance-attribute

Python

immutable_collections: int = 0

mutable_collectionsclass-attributeinstance-attribute

Python

mutable_collections: int = 0

throw_statementsclass-attributeinstance-attribute

Python

throw_statements: int = 0

option_usageclass-attributeinstance-attribute

Python

option_usage: int = 0

either_usageclass-attributeinstance-attribute

Python

either_usage: int = 0

try_usageclass-attributeinstance-attribute

Python

try_usage: int = 0

signal_countclass-attributeinstance-attribute

Python

signal_count: int = 0

export_countclass-attributeinstance-attribute

Python

export_count: int = 0

onready_countclass-attributeinstance-attribute

Python

onready_count: int = 0

node_ref_countclass-attributeinstance-attribute

Python

node_ref_count: int = 0

get_node_countclass-attributeinstance-attribute

Python

get_node_count: int = 0

connect_countclass-attributeinstance-attribute

Python

connect_count: int = 0

emit_countclass-attributeinstance-attribute

Python

emit_count: int = 0

lifecycle_countclass-attributeinstance-attribute

Python

lifecycle_count: int = 0

rpc_countclass-attributeinstance-attribute

Python

rpc_count: int = 0

typed_varsclass-attributeinstance-attribute

Python

typed_vars: int = 0

typed_funcsclass-attributeinstance-attribute

Python

typed_funcs: int = 0

return_typesclass-attributeinstance-attribute

Python

return_types: int = 0

has_cspclass-attributeinstance-attribute

Python

has_csp: bool = False

has_integrity_checksclass-attributeinstance-attribute

Python

has_integrity_checks: bool = False

has_https_linksclass-attributeinstance-attribute

Python

has_https_links: int = 0

delegation_countclass-attributeinstance-attribute

Python

delegation_count: int = 0

lazy_propertiesclass-attributeinstance-attribute

Python

lazy_properties: int = 0

observable_propertiesclass-attributeinstance-attribute

Python

observable_properties: int = 0

lateinit_countclass-attributeinstance-attribute

Python

lateinit_count: int = 0

Functions

to_dict

Python

to_dict() -> Dict[str, Any]

Convert to dictionary representation.

RETURNS	DESCRIPTION
Dict[str, Any]	Dict containing all metrics

DependencyGraphdataclass

Python

DependencyGraph(nodes: Dict[str, Any] = dict(), edges: List[tuple] = list(), cycles: List[List[str]] = list())

Represents project dependency graph.

Tracks dependencies between files and modules in the project.

ATTRIBUTE	DESCRIPTION
nodes	Dictionary of node ID to node data TYPE:Dict[str, Any]
edges	List of edges (from_id, to_id, edge_data) TYPE:List[tuple]
cycles	List of detected dependency cycles TYPE:List[List[str]]

Attributes

nodesclass-attributeinstance-attribute

Python

nodes: Dict[str, Any] = field(default_factory=dict)

edgesclass-attributeinstance-attribute

Python

edges: List[tuple] = field(default_factory=list)

cyclesclass-attributeinstance-attribute

Python

cycles: List[List[str]] = field(default_factory=list)

Functions

add_node

Python

add_node(node_id: str, data: Any) -> None

Add a node to the dependency graph.

PARAMETER	DESCRIPTION
node_id	Unique identifier for the node TYPE:str
data	Node data (typically FileAnalysis) TYPE:Any

add_edge

Python

add_edge(from_id: str, to_id: str, import_info: Optional[ImportInfo] = None) -> None

Add an edge representing a dependency.

PARAMETER	DESCRIPTION
from_id	Source node ID TYPE:str
to_id	Target node ID TYPE:str
import_info	Optional import information TYPE:Optional[ImportInfo]DEFAULT:None

calculate_metrics

Python

calculate_metrics() -> None

Calculate graph metrics like centrality and cycles.

Updates internal metrics based on current graph structure.

to_dict

Python

to_dict() -> Dict[str, Any]

Convert to dictionary representation.

RETURNS	DESCRIPTION
Dict[str, Any]	Dict containing graph structure

FileAnalysisdataclass

Python

FileAnalysis(path: str, content: str = '', size: int = 0, lines: int = 0, language: str = 'unknown', file_name: str = '', file_extension: str = '', last_modified: Optional[datetime] = None, hash: Optional[str] = None, imports: List[ImportInfo] = list(), exports: List[Dict[str, Any]] = list(), structure: Optional[CodeStructure] = None, complexity: Optional[ComplexityMetrics] = None, classes: List[ClassInfo] = list(), functions: List[FunctionInfo] = list(), keywords: List[str] = list(), git_info: Optional[Dict[str, Any]] = None, relevance_score: float = 0.0, quality_score: float = 0.0, error: Optional[str] = None)

Complete analysis results for a single file.

Contains all information extracted from analyzing a source code file, including structure, complexity, and metadata.

ATTRIBUTE	DESCRIPTION
path	File path TYPE:str
content	File content TYPE:str
size	File size in bytes TYPE:int
lines	Number of lines TYPE:int
language	Programming language TYPE:str
file_name	Name of the file TYPE:str
file_extension	File extension TYPE:str
last_modified	Last modification time TYPE:Optional[datetime]
hash	Content hash TYPE:Optional[str]
imports	List of imports TYPE:List[ImportInfo]
exports	List of exports TYPE:List[Dict[str, Any]]
structure	Code structure information TYPE:Optional[CodeStructure]
complexity	Complexity metrics TYPE:Optional[ComplexityMetrics]
classes	List of classes (convenience accessor) TYPE:List[ClassInfo]
functions	List of functions (convenience accessor) TYPE:List[FunctionInfo]
keywords	Extracted keywords TYPE:List[str]
relevance_score	Relevance score for ranking TYPE:float
quality_score	Code quality score TYPE:float
error	Any error encountered during analysis TYPE:Optional[str]

Attributes

pathinstance-attribute

Python

path: str

contentclass-attributeinstance-attribute

Python

content: str = ''

sizeclass-attributeinstance-attribute

Python

size: int = 0

linesclass-attributeinstance-attribute

Python

lines: int = 0

languageclass-attributeinstance-attribute

Python

language: str = 'unknown'

file_nameclass-attributeinstance-attribute

Python

file_name: str = ''

file_extensionclass-attributeinstance-attribute

Python

file_extension: str = ''

last_modifiedclass-attributeinstance-attribute

Python

last_modified: Optional[datetime] = None

hashclass-attributeinstance-attribute

Python

hash: Optional[str] = None

importsclass-attributeinstance-attribute

Python

imports: List[ImportInfo] = field(default_factory=list)

exportsclass-attributeinstance-attribute

Python

exports: List[Dict[str, Any]] = field(default_factory=list)

structureclass-attributeinstance-attribute

Python

structure: Optional[CodeStructure] = None

complexityclass-attributeinstance-attribute

Python

complexity: Optional[ComplexityMetrics] = None

classesclass-attributeinstance-attribute

Python

classes: List[ClassInfo] = field(default_factory=list)

functionsclass-attributeinstance-attribute

Python

functions: List[FunctionInfo] = field(default_factory=list)

keywordsclass-attributeinstance-attribute

Python

keywords: List[str] = field(default_factory=list)

git_infoclass-attributeinstance-attribute

Python

git_info: Optional[Dict[str, Any]] = None

relevance_scoreclass-attributeinstance-attribute

Python

relevance_score: float = 0.0

quality_scoreclass-attributeinstance-attribute

Python

quality_score: float = 0.0

errorclass-attributeinstance-attribute

Python

error: Optional[str] = None

Functions

to_dict

Python

to_dict() -> Dict[str, Any]

Convert to dictionary representation.

RETURNS	DESCRIPTION
Dict[str, Any]	Dict containing all file analysis data

from_dictclassmethod

Python

from_dict(data: Dict[str, Any]) -> FileAnalysis

Create FileAnalysis from dictionary.

PARAMETER	DESCRIPTION
data	Dictionary containing file analysis data TYPE:Dict[str, Any]

RETURNS	DESCRIPTION
FileAnalysis	FileAnalysis instance

FunctionInfodataclass

Python

FunctionInfo(name: str, line_start: int = 0, line_end: int = 0, parameters: List[str] = list(), complexity: int = 1, line: int = 0, end_line: int = 0, is_toplevel: bool = False, args: List[str] = list(), decorators: List[str] = list(), is_async: bool = False, docstring: Optional[str] = None, return_type: Optional[str] = None, is_constructor: bool = False, is_abstract: bool = False, is_static: bool = False, is_class: bool = False, is_property: bool = False, is_private: bool = False, is_generator: bool = False, is_exported: bool = False, is_arrow: bool = False, generics: Optional[str] = None, is_inline: bool = False, is_constexpr: bool = False, is_template: bool = False, is_extern: bool = False, is_unsafe: bool = False, is_const: bool = False, is_public: bool = False, visibility: Optional[str] = None, modifiers: List[str] = list(), type_parameters: Optional[str] = None, receiver_type: Optional[str] = None, is_extension: bool = False, is_suspend: bool = False, is_operator: bool = False, is_infix: bool = False, is_implicit: bool = False, is_curried: bool = False, is_lifecycle: bool = False, is_virtual: bool = False, access_level: Optional[str] = None, is_throwing: bool = False, where_clause: Optional[str] = None)

Information about a function or method.

Represents functions, methods, procedures across languages.

ATTRIBUTE	DESCRIPTION
name	Function/method name TYPE:str
line_start	Starting line number TYPE:int
line_end	Ending line number TYPE:int
parameters	List of parameter names TYPE:List[str]
complexity	Cyclomatic complexity of the function TYPE:int
line	Compatibility alias for line_start TYPE:int
end_line	Compatibility alias for line_end TYPE:int
is_toplevel	Whether function is top-level (for some analyzers) TYPE:bool
args	Argument strings with type hints (analyzer compatibility) TYPE:List[str]
decorators	Decorators applied to the function TYPE:List[str]
is_async	Whether the function is async TYPE:bool
docstring	Function docstring TYPE:Optional[str]
return_type	Return type annotation TYPE:Optional[str]

Attributes

nameinstance-attribute

Python

name: str

line_startclass-attributeinstance-attribute

Python

line_start: int = 0

line_endclass-attributeinstance-attribute

Python

line_end: int = 0

parametersclass-attributeinstance-attribute

Python

parameters: List[str] = field(default_factory=list)

complexityclass-attributeinstance-attribute

Python

complexity: int = 1

lineclass-attributeinstance-attribute

Python

line: int = 0

end_lineclass-attributeinstance-attribute

Python

end_line: int = 0

is_toplevelclass-attributeinstance-attribute

Python

is_toplevel: bool = False

argsclass-attributeinstance-attribute

Python

args: List[str] = field(default_factory=list)

decoratorsclass-attributeinstance-attribute

Python

decorators: List[str] = field(default_factory=list)

is_asyncclass-attributeinstance-attribute

Python

is_async: bool = False

docstringclass-attributeinstance-attribute

Python

docstring: Optional[str] = None

return_typeclass-attributeinstance-attribute

Python

return_type: Optional[str] = None

is_constructorclass-attributeinstance-attribute

Python

is_constructor: bool = False

is_abstractclass-attributeinstance-attribute

Python

is_abstract: bool = False

is_staticclass-attributeinstance-attribute

Python

is_static: bool = False

is_classclass-attributeinstance-attribute

Python

is_class: bool = False

is_propertyclass-attributeinstance-attribute

Python

is_property: bool = False

is_privateclass-attributeinstance-attribute

Python

is_private: bool = False

is_generatorclass-attributeinstance-attribute

Python

is_generator: bool = False

is_exportedclass-attributeinstance-attribute

Python

is_exported: bool = False

is_arrowclass-attributeinstance-attribute

Python

is_arrow: bool = False

genericsclass-attributeinstance-attribute

Python

generics: Optional[str] = None

is_inlineclass-attributeinstance-attribute

Python

is_inline: bool = False

is_constexprclass-attributeinstance-attribute

Python

is_constexpr: bool = False

is_templateclass-attributeinstance-attribute

Python

is_template: bool = False

is_externclass-attributeinstance-attribute

Python

is_extern: bool = False

is_unsafeclass-attributeinstance-attribute

Python

is_unsafe: bool = False

is_constclass-attributeinstance-attribute

Python

is_const: bool = False

is_publicclass-attributeinstance-attribute

Python

is_public: bool = False

visibilityclass-attributeinstance-attribute

Python

visibility: Optional[str] = None

modifiersclass-attributeinstance-attribute

Python

modifiers: List[str] = field(default_factory=list)

type_parametersclass-attributeinstance-attribute

Python

type_parameters: Optional[str] = None

receiver_typeclass-attributeinstance-attribute

Python

receiver_type: Optional[str] = None

is_extensionclass-attributeinstance-attribute

Python

is_extension: bool = False

is_suspendclass-attributeinstance-attribute

Python

is_suspend: bool = False

is_operatorclass-attributeinstance-attribute

Python

is_operator: bool = False

is_infixclass-attributeinstance-attribute

Python

is_infix: bool = False

is_implicitclass-attributeinstance-attribute

Python

is_implicit: bool = False

is_curriedclass-attributeinstance-attribute

Python

is_curried: bool = False

is_lifecycleclass-attributeinstance-attribute

Python

is_lifecycle: bool = False

is_virtualclass-attributeinstance-attribute

Python

is_virtual: bool = False

access_levelclass-attributeinstance-attribute

Python

access_level: Optional[str] = None

is_throwingclass-attributeinstance-attribute

Python

is_throwing: bool = False

where_clauseclass-attributeinstance-attribute

Python

where_clause: Optional[str] = None

Functions

to_dict

Python

to_dict() -> Dict[str, Any]

Convert to dictionary representation.

RETURNS	DESCRIPTION
Dict[str, Any]	Dict containing function information

ImportInfodataclass

Python

ImportInfo(module: str, alias: Optional[str] = None, line: int = 0, type: str = 'import', is_relative: bool = False, level: int = 0, from_module: Optional[str] = None, is_stdlib: bool = False, is_stl: bool = False, conditional: bool = False, is_project_header: bool = False, is_project_file: bool = False, has_include_guard: bool = False, uses_pragma_once: bool = False, import_clause: Optional[str] = None, original_name: Optional[str] = None, is_wildcard: bool = False, category: Optional[str] = None, package: Optional[str] = None, namespace: Optional[str] = None, import_type: Optional[str] = None, is_file_include: bool = False, is_dynamic: bool = False, reloads: bool = False, is_gem: bool = False, is_autoload: bool = False, lazy_load: bool = False, is_unity: bool = False, namespace_context: Optional[str] = None, is_project_reference: bool = False, is_external: bool = False, is_module_declaration: bool = False, is_glob: bool = False, is_dev_dependency: bool = False, is_dependency: bool = False, version: Optional[str] = None, loads_all_gems: bool = False, is_renamed: bool = False, is_given: bool = False, is_resource: bool = False, resource_type: Optional[str] = None, is_runtime_load: bool = False, is_inheritance: bool = False, parent_type: Optional[str] = None, associated_class: Optional[str] = None, is_editor_script: bool = False, is_package_declaration: bool = False, is_package: bool = False, is_dart_core: bool = False, is_deferred: bool = False, show_symbols: List[str] = list(), hide_symbols: List[str] = list(), is_part_file: bool = False, is_library_part: bool = False, is_library_declaration: bool = False, package_context: Optional[str] = None, is_android: bool = False, integrity: Optional[str] = None, crossorigin: Optional[str] = None, is_async: bool = False, is_defer: bool = False, is_module: bool = False, as_type: Optional[str] = None, media_query: Optional[str] = None, layer: Optional[str] = None, supports: Optional[str] = None, config: Optional[str] = None, visibility: Optional[str] = None, composes: Optional[str] = None, is_apple: bool = False, is_apple_framework: bool = False, is_testable: bool = False, is_exported: bool = False, import_kind: Optional[str] = None)

Information about an import statement in code.

Represents imports across different languages (import, require, include, use).

ATTRIBUTE	DESCRIPTION
module	The imported module/package name TYPE:str
alias	Any alias assigned to the import TYPE:Optional[str]
line	Line number where import appears TYPE:int
type	Type of import (import, from, require, include) TYPE:str
is_relative	Whether this is a relative import TYPE:bool
level	Relative import level (Python), 0 for absolute TYPE:int
from_module	Module specified in a 'from X import ...' statement TYPE:Optional[str]

Attributes

moduleinstance-attribute

Python

module: str

aliasclass-attributeinstance-attribute

Python

alias: Optional[str] = None

lineclass-attributeinstance-attribute

Python

line: int = 0

typeclass-attributeinstance-attribute

Python

type: str = 'import'

is_relativeclass-attributeinstance-attribute

Python

is_relative: bool = False

levelclass-attributeinstance-attribute

Python

level: int = 0

from_moduleclass-attributeinstance-attribute

Python

from_module: Optional[str] = None

is_stdlibclass-attributeinstance-attribute

Python

is_stdlib: bool = False

is_stlclass-attributeinstance-attribute

Python

is_stl: bool = False

conditionalclass-attributeinstance-attribute

Python

conditional: bool = False

is_project_headerclass-attributeinstance-attribute

Python

is_project_header: bool = False

is_project_fileclass-attributeinstance-attribute

Python

is_project_file: bool = False

has_include_guardclass-attributeinstance-attribute

Python

has_include_guard: bool = False

uses_pragma_onceclass-attributeinstance-attribute

Python

uses_pragma_once: bool = False

import_clauseclass-attributeinstance-attribute

Python

import_clause: Optional[str] = None

original_nameclass-attributeinstance-attribute

Python

original_name: Optional[str] = None

is_wildcardclass-attributeinstance-attribute

Python

is_wildcard: bool = False

categoryclass-attributeinstance-attribute

Python

category: Optional[str] = None

packageclass-attributeinstance-attribute

Python

package: Optional[str] = None

namespaceclass-attributeinstance-attribute

Python

namespace: Optional[str] = None

import_typeclass-attributeinstance-attribute

Python

import_type: Optional[str] = None

is_file_includeclass-attributeinstance-attribute

Python

is_file_include: bool = False

is_dynamicclass-attributeinstance-attribute

Python

is_dynamic: bool = False

reloadsclass-attributeinstance-attribute

Python

reloads: bool = False

is_gemclass-attributeinstance-attribute

Python

is_gem: bool = False

is_autoloadclass-attributeinstance-attribute

Python

is_autoload: bool = False

lazy_loadclass-attributeinstance-attribute

Python

lazy_load: bool = False

is_unityclass-attributeinstance-attribute

Python

is_unity: bool = False

namespace_contextclass-attributeinstance-attribute

Python

namespace_context: Optional[str] = None

is_project_referenceclass-attributeinstance-attribute

Python

is_project_reference: bool = False

is_externalclass-attributeinstance-attribute

Python

is_external: bool = False

is_module_declarationclass-attributeinstance-attribute

Python

is_module_declaration: bool = False

is_globclass-attributeinstance-attribute

Python

is_glob: bool = False

is_dev_dependencyclass-attributeinstance-attribute

Python

is_dev_dependency: bool = False

is_dependencyclass-attributeinstance-attribute

Python

is_dependency: bool = False

versionclass-attributeinstance-attribute

Python

version: Optional[str] = None

loads_all_gemsclass-attributeinstance-attribute

Python

loads_all_gems: bool = False

is_renamedclass-attributeinstance-attribute

Python

is_renamed: bool = False

is_givenclass-attributeinstance-attribute

Python

is_given: bool = False

is_resourceclass-attributeinstance-attribute

Python

is_resource: bool = False

resource_typeclass-attributeinstance-attribute

Python

resource_type: Optional[str] = None

is_runtime_loadclass-attributeinstance-attribute

Python

is_runtime_load: bool = False

is_inheritanceclass-attributeinstance-attribute

Python

is_inheritance: bool = False

parent_typeclass-attributeinstance-attribute

Python

parent_type: Optional[str] = None

associated_classclass-attributeinstance-attribute

Python

associated_class: Optional[str] = None

is_editor_scriptclass-attributeinstance-attribute

Python

is_editor_script: bool = False

is_package_declarationclass-attributeinstance-attribute

Python

is_package_declaration: bool = False

is_packageclass-attributeinstance-attribute

Python

is_package: bool = False

is_dart_coreclass-attributeinstance-attribute

Python

is_dart_core: bool = False

is_deferredclass-attributeinstance-attribute

Python

is_deferred: bool = False

show_symbolsclass-attributeinstance-attribute

Python

show_symbols: List[str] = field(default_factory=list)

hide_symbolsclass-attributeinstance-attribute

Python

hide_symbols: List[str] = field(default_factory=list)

is_part_fileclass-attributeinstance-attribute

Python

is_part_file: bool = False

is_library_partclass-attributeinstance-attribute

Python

is_library_part: bool = False

is_library_declarationclass-attributeinstance-attribute

Python

is_library_declaration: bool = False

package_contextclass-attributeinstance-attribute

Python

package_context: Optional[str] = None

is_androidclass-attributeinstance-attribute

Python

is_android: bool = False

integrityclass-attributeinstance-attribute

Python

integrity: Optional[str] = None

crossoriginclass-attributeinstance-attribute

Python

crossorigin: Optional[str] = None

is_asyncclass-attributeinstance-attribute

Python

is_async: bool = False

is_deferclass-attributeinstance-attribute

Python

is_defer: bool = False

is_moduleclass-attributeinstance-attribute

Python

is_module: bool = False

as_typeclass-attributeinstance-attribute

Python

as_type: Optional[str] = None

media_queryclass-attributeinstance-attribute

Python

media_query: Optional[str] = None

layerclass-attributeinstance-attribute

Python

layer: Optional[str] = None

supportsclass-attributeinstance-attribute

Python

supports: Optional[str] = None

configclass-attributeinstance-attribute

Python

config: Optional[str] = None

visibilityclass-attributeinstance-attribute

Python

visibility: Optional[str] = None

composesclass-attributeinstance-attribute

Python

composes: Optional[str] = None

is_appleclass-attributeinstance-attribute

Python

is_apple: bool = False

is_apple_frameworkclass-attributeinstance-attribute

Python

is_apple_framework: bool = False

is_testableclass-attributeinstance-attribute

Python

is_testable: bool = False

is_exportedclass-attributeinstance-attribute

Python

is_exported: bool = False

import_kindclass-attributeinstance-attribute

Python

import_kind: Optional[str] = None

Functions

to_dict

Python

to_dict() -> Dict[str, Any]

Convert to dictionary representation.

RETURNS	DESCRIPTION
Dict[str, Any]	Dict containing all import information

ProjectAnalysisdataclass

Python

ProjectAnalysis(path: str, name: str, files: List[FileAnalysis] = list(), total_files: int = 0, analyzed_files: int = 0, failed_files: int = 0, total_lines: int = 0, total_code_lines: int = 0, total_comment_lines: int = 0, average_complexity: float = 0.0, total_functions: int = 0, total_classes: int = 0, languages: Dict[str, int] = dict(), language_distribution: Dict[str, float] = dict(), frameworks: List[str] = list(), project_type: str = 'unknown', dependency_graph: Optional[DependencyGraph] = None, summary: Dict[str, Any] = dict())

Analysis results for an entire project.

Aggregates file-level analysis into project-wide metrics and insights.

ATTRIBUTE	DESCRIPTION
path	Project root path TYPE:str
name	Project name TYPE:str
files	List of analyzed files TYPE:List[FileAnalysis]
total_files	Total number of files TYPE:int
analyzed_files	Number of successfully analyzed files TYPE:int
failed_files	Number of files that failed analysis TYPE:int
total_lines	Total lines of code TYPE:int
total_code_lines	Total non-blank, non-comment lines TYPE:int
total_comment_lines	Total comment lines TYPE:int
average_complexity	Average cyclomatic complexity TYPE:float
total_functions	Total number of functions TYPE:int
total_classes	Total number of classes TYPE:int
languages	Language distribution (language -> file count) TYPE:Dict[str, int]
language_distribution	Percentage distribution of languages TYPE:Dict[str, float]
frameworks	Detected frameworks TYPE:List[str]
project_type	Type of project (web, library, cli, etc.) TYPE:str
dependency_graph	Project dependency graph TYPE:Optional[DependencyGraph]
summary	Project summary dictionary TYPE:Dict[str, Any]

Attributes

pathinstance-attribute

Python

path: str

nameinstance-attribute

Python

name: str

filesclass-attributeinstance-attribute

Python

files: List[FileAnalysis] = field(default_factory=list)

total_filesclass-attributeinstance-attribute

Python

total_files: int = 0

analyzed_filesclass-attributeinstance-attribute

Python

analyzed_files: int = 0

failed_filesclass-attributeinstance-attribute

Python

failed_files: int = 0

total_linesclass-attributeinstance-attribute

Python

total_lines: int = 0

total_code_linesclass-attributeinstance-attribute

Python

total_code_lines: int = 0

total_comment_linesclass-attributeinstance-attribute

Python

total_comment_lines: int = 0

average_complexityclass-attributeinstance-attribute

Python

average_complexity: float = 0.0

total_functionsclass-attributeinstance-attribute

Python

total_functions: int = 0

total_classesclass-attributeinstance-attribute

Python

total_classes: int = 0

languagesclass-attributeinstance-attribute

Python

languages: Dict[str, int] = field(default_factory=dict)

language_distributionclass-attributeinstance-attribute

Python

language_distribution: Dict[str, float] = field(default_factory=dict)

frameworksclass-attributeinstance-attribute

Python

frameworks: List[str] = field(default_factory=list)

project_typeclass-attributeinstance-attribute

Python

project_type: str = 'unknown'

dependency_graphclass-attributeinstance-attribute

Python

dependency_graph: Optional[DependencyGraph] = None

summaryclass-attributeinstance-attribute

Python

summary: Dict[str, Any] = field(default_factory=dict)

Functions

to_dict

Python

to_dict() -> Dict[str, Any]

Convert to dictionary representation.

RETURNS	DESCRIPTION
Dict[str, Any]	Dict containing all project analysis data

ContextResultdataclass

Python

ContextResult(content: Optional[str] = None, context: Optional[str] = None, format: str = 'markdown', token_count: int = 0, files: list[str] = list(), files_included: list[str] = list(), files_summarized: list[str] = list(), metadata: dict[str, Any] = dict(), session_id: Optional[str] = None, timestamp: datetime = datetime.now(), statistics: dict[str, Any] = dict(), prompt_context: Optional[PromptContext] = None, cost_estimate: Optional[dict[str, float]] = None, warnings: list[str] = list(), errors: list[str] = list())

Result of context generation.

Contains the generated context ready for consumption by LLMs or other tools. This is the final output of the distillation process.

ATTRIBUTE	DESCRIPTION
content	The generated context content (preferred alias) TYPE:Optional[str]
context	Backward-compatible alias for content TYPE:Optional[str]
format	Output format (markdown, xml, json) TYPE:str
token_count	Number of tokens in context TYPE:int
files	List of included file paths (preferred alias) TYPE:list[str]
files_included	Backward-compatible alias for files TYPE:list[str]
files_summarized	List of summarized file paths TYPE:list[str]
metadata	Additional metadata about generation, including: - timing: Dict with duration info (if timing enabled) - duration: float seconds - formatted_duration: Human-readable string (e.g. "2.34s") - start_datetime: ISO format start time - end_datetime: ISO format end time TYPE:dict[str, Any]
session_id	Session this belongs to TYPE:Optional[str]
timestamp	When context was generated TYPE:datetime
statistics	Generation statistics TYPE:dict[str, Any]
prompt_context	Original prompt context TYPE:Optional[PromptContext]
cost_estimate	Estimated cost for LLM usage TYPE:Optional[dict[str, float]]
warnings	Any warnings during generation TYPE:list[str]
errors	Any errors during generation TYPE:list[str]

Attributes

contentclass-attributeinstance-attribute

Python

content: Optional[str] = None

contextclass-attributeinstance-attribute

Python

context: Optional[str] = None

formatclass-attributeinstance-attribute

Python

format: str = 'markdown'

token_countclass-attributeinstance-attribute

Python

token_count: int = 0

filesclass-attributeinstance-attribute

Python

files: list[str] = field(default_factory=list)

files_includedclass-attributeinstance-attribute

Python

files_included: list[str] = field(default_factory=list)

files_summarizedclass-attributeinstance-attribute

Python

files_summarized: list[str] = field(default_factory=list)

metadataclass-attributeinstance-attribute

Python

metadata: dict[str, Any] = field(default_factory=dict)

session_idclass-attributeinstance-attribute

Python

session_id: Optional[str] = None

timestampclass-attributeinstance-attribute

Python

timestamp: datetime = field(default_factory=now)

statisticsclass-attributeinstance-attribute

Python

statistics: dict[str, Any] = field(default_factory=dict)

prompt_contextclass-attributeinstance-attribute

Python

prompt_context: Optional[PromptContext] = None

cost_estimateclass-attributeinstance-attribute

Python

cost_estimate: Optional[dict[str, float]] = None

warningsclass-attributeinstance-attribute

Python

warnings: list[str] = field(default_factory=list)

errorsclass-attributeinstance-attribute

Python

errors: list[str] = field(default_factory=list)

Functions

add_warning

Python

add_warning(warning: str) -> None

Add a warning message.

add_error

Python

add_error(error: str) -> None

Add an error message.

update_statistics

Python

update_statistics(key: str, value: Any) -> None

Update a statistic value.

to_dict

Python

to_dict() -> dict[str, Any]

Convert to dictionary representation.

from_dictclassmethod

Python

from_dict(data: dict[str, Any]) -> ContextResult

Create from dictionary.

save_to_file

Python

save_to_file(path: Union[str, Path]) -> None

Save context result to file.

get_summary

Python

get_summary() -> str

Get a summary of the context result.

PromptContextdataclass

Python

PromptContext(text: str, original: Optional[str] = None, keywords: list[str] = list(), task_type: str = 'general', intent: str = 'understand', entities: list[dict[str, Any]] = list(), file_patterns: list[str] = list(), focus_areas: list[str] = list(), temporal_context: Optional[dict[str, Any]] = None, scope: dict[str, Any] = dict(), external_context: Optional[dict[str, Any]] = None, metadata: dict[str, Any] = dict(), confidence_scores: dict[str, float] = dict(), session_id: Optional[str] = None, timestamp: datetime = datetime.now(), include_tests: bool = False)

Context extracted from user prompt.

Contains all information parsed from the prompt to guide file selection and ranking. This is the primary data structure that flows through the system after prompt parsing.

ATTRIBUTE	DESCRIPTION
text	The processed prompt text (cleaned and normalized) TYPE:str
original	Original input (may be URL or raw text) TYPE:Optional[str]
keywords	Extracted keywords for searching TYPE:list[str]
task_type	Type of task detected TYPE:str
intent	User intent classification TYPE:str
entities	Named entities found (classes, functions, modules) TYPE:list[dict[str, Any]]
file_patterns	File patterns to match (.py, test_, etc) TYPE:list[str]
focus_areas	Areas to focus on (auth, api, database, etc) TYPE:list[str]
temporal_context	Time-related context (recent, yesterday, etc) TYPE:Optional[dict[str, Any]]
scope	Scope indicators (modules, directories, exclusions) TYPE:dict[str, Any]
external_context	Context from external sources (GitHub, JIRA) TYPE:Optional[dict[str, Any]]
metadata	Additional metadata for processing TYPE:dict[str, Any]
confidence_scores	Confidence scores for various extractions TYPE:dict[str, float]
session_id	Associated session if any TYPE:Optional[str]
timestamp	When context was created TYPE:datetime

Attributes

textinstance-attribute

Python

text: str

originalclass-attributeinstance-attribute

Python

original: Optional[str] = None

keywordsclass-attributeinstance-attribute

Python

keywords: list[str] = field(default_factory=list)

task_typeclass-attributeinstance-attribute

Python

task_type: str = 'general'

intentclass-attributeinstance-attribute

Python

intent: str = 'understand'

entitiesclass-attributeinstance-attribute

Python

entities: list[dict[str, Any]] = field(default_factory=list)

file_patternsclass-attributeinstance-attribute

Python

file_patterns: list[str] = field(default_factory=list)

focus_areasclass-attributeinstance-attribute

Python

focus_areas: list[str] = field(default_factory=list)

temporal_contextclass-attributeinstance-attribute

Python

temporal_context: Optional[dict[str, Any]] = None

scopeclass-attributeinstance-attribute

Python

scope: dict[str, Any] = field(default_factory=dict)

external_contextclass-attributeinstance-attribute

Python

external_context: Optional[dict[str, Any]] = None

metadataclass-attributeinstance-attribute

Python

metadata: dict[str, Any] = field(default_factory=dict)

confidence_scoresclass-attributeinstance-attribute

Python

confidence_scores: dict[str, float] = field(default_factory=dict)

session_idclass-attributeinstance-attribute

Python

session_id: Optional[str] = None

timestampclass-attributeinstance-attribute

Python

timestamp: datetime = field(default_factory=now)

include_testsclass-attributeinstance-attribute

Python

include_tests: bool = False

Functions

add_keyword

Python

add_keyword(keyword: str, confidence: float = 1.0) -> None

Add a keyword with confidence score.

add_entity

Python

add_entity(name: str, entity_type: str, confidence: float = 1.0) -> None

Add an entity with type and confidence.

add_focus_area

Python

add_focus_area(area: str) -> None

Add a focus area if not already present.

merge_with

Python

merge_with(other: PromptContext) -> PromptContext

Merge this context with another.

to_dict

Python

to_dict() -> dict[str, Any]

Convert to dictionary representation.

from_dictclassmethod

Python

from_dict(data: dict[str, Any]) -> PromptContext

Create PromptContext from dictionary.

get_hash

Python

get_hash() -> str

Compute a deterministic cache key for this prompt context.

The hash incorporates the normalized prompt text, task type, and the ordered list of unique keywords. MD5 is chosen (with usedforsecurity=False) for speed; collision risk is acceptable for internal memoization.

RETURNS	DESCRIPTION
str	Hex digest suitable for use as an internal cache key. TYPE:str

SessionContextdataclass

Python

SessionContext(session_id: str, name: str = '', project_root: Optional[Path] = None, shown_files: set[str] = set(), ignored_files: set[str] = set(), context_history: list[ContextResult] = list(), current_focus: list[str] = list(), tenets_applied: list[str] = list(), created_at: datetime = datetime.now(), updated_at: datetime = datetime.now(), metadata: dict[str, Any] = dict(), ai_requests: list[dict[str, Any]] = list(), branch: Optional[str] = None, pinned_files: set[str] = set())

Context for a session.

Maintains state across multiple prompts in a session for incremental context building and state management.

ATTRIBUTE	DESCRIPTION
session_id	Unique session identifier TYPE:str
name	Human-readable session name TYPE:str
project_root	Root path of the project TYPE:Optional[Path]
shown_files	Files explicitly shown TYPE:set[str]
ignored_files	Files to ignore TYPE:set[str]
context_history	History of contexts TYPE:list[ContextResult]
current_focus	Current focus areas TYPE:list[str]
tenets_applied	Tenets applied in session TYPE:list[str]
created_at	When session was created TYPE:datetime
updated_at	Last update time TYPE:datetime
metadata	Session metadata TYPE:dict[str, Any]
ai_requests	History of AI requests TYPE:list[dict[str, Any]]
branch	Git branch if applicable TYPE:Optional[str]

Attributes

session_idinstance-attribute

Python

session_id: str

nameclass-attributeinstance-attribute

Python

name: str = ''

project_rootclass-attributeinstance-attribute

Python

project_root: Optional[Path] = None

shown_filesclass-attributeinstance-attribute

Python

shown_files: set[str] = field(default_factory=set)

ignored_filesclass-attributeinstance-attribute

Python

ignored_files: set[str] = field(default_factory=set)

context_historyclass-attributeinstance-attribute

Python

context_history: list[ContextResult] = field(default_factory=list)

current_focusclass-attributeinstance-attribute

Python

current_focus: list[str] = field(default_factory=list)

tenets_appliedclass-attributeinstance-attribute

Python

tenets_applied: list[str] = field(default_factory=list)

created_atclass-attributeinstance-attribute

Python

created_at: datetime = field(default_factory=now)

updated_atclass-attributeinstance-attribute

Python

updated_at: datetime = field(default_factory=now)

metadataclass-attributeinstance-attribute

Python

metadata: dict[str, Any] = field(default_factory=dict)

ai_requestsclass-attributeinstance-attribute

Python

ai_requests: list[dict[str, Any]] = field(default_factory=list)

branchclass-attributeinstance-attribute

Python

branch: Optional[str] = None

pinned_filesclass-attributeinstance-attribute

Python

pinned_files: set[str] = field(default_factory=set)

Functions

add_shown_file

Python

add_shown_file(file_path: str) -> None

Mark file as shown.

add_ignored_file

Python

add_ignored_file(file_path: str) -> None

Mark file as ignored.

add_context

Python

add_context(context: ContextResult) -> None

Add context to history.

add_ai_request

Python

add_ai_request(request_type: str, request_data: dict[str, Any]) -> None

Record an AI request.

add_pinned_file

Python

add_pinned_file(file_path: str) -> None

Pin a file so it is always considered for future distill operations.

PARAMETER	DESCRIPTION
file_path	Absolute or project-relative path to the file. TYPE:str

list_pinned_files

Python

list_pinned_files() -> list[str]

Return pinned file paths.

get_latest_context

Python

get_latest_context() -> Optional[ContextResult]

Get the most recent context.

should_show_file

Python

should_show_file(file_path: str) -> bool

Check if file should be shown based on session state.

to_dict

Python

to_dict() -> dict[str, Any]

Convert to dictionary representation.

from_dictclassmethod

Python

from_dict(data: dict[str, Any]) -> SessionContext

Create from dictionary.

TaskType

Bases: Enum

Types of tasks detected in prompts.

Attributes

FEATUREclass-attributeinstance-attribute

Python

FEATURE = 'feature'

DEBUGclass-attributeinstance-attribute

Python

DEBUG = 'debug'

TESTclass-attributeinstance-attribute

Python

TEST = 'test'

REFACTORclass-attributeinstance-attribute

Python

REFACTOR = 'refactor'

UNDERSTANDclass-attributeinstance-attribute

Python

UNDERSTAND = 'understand'

REVIEWclass-attributeinstance-attribute

Python

REVIEW = 'review'

DOCUMENTclass-attributeinstance-attribute

Python

DOCUMENT = 'document'

OPTIMIZEclass-attributeinstance-attribute

Python

OPTIMIZE = 'optimize'

SECURITYclass-attributeinstance-attribute

Python

SECURITY = 'security'

ARCHITECTUREclass-attributeinstance-attribute

Python

ARCHITECTURE = 'architecture'

MIGRATIONclass-attributeinstance-attribute

Python

MIGRATION = 'migration'

GENERALclass-attributeinstance-attribute

Python

GENERAL = 'general'

Functions

from_stringclassmethod

Python

from_string(value: str) -> TaskType

Create TaskType from string value.

ModelLimitsdataclass

Python

ModelLimits(max_context: int, max_output: int)

Attributes

max_contextinstance-attribute

Python

max_context: int

max_outputinstance-attribute

Python

max_output: int

ModelPricingdataclass

Python

ModelPricing(input_per_1k: float, output_per_1k: float)

Attributes

input_per_1kinstance-attribute

Python

input_per_1k: float

output_per_1kinstance-attribute

Python

output_per_1k: float

FileSummarydataclass

Python

FileSummary(content: str = '', was_summarized: bool = True, original_tokens: int = 0, summary_tokens: int = 0, original_lines: int = 0, summary_lines: int = 0, preserved_sections: List[str] = list(), ignored_sections: List[str] = list(), sections: List[SummarySection] = list(), strategy: str = 'extract', compression_ratio: float = 0.0, instructions: List[str] = list(), metadata: Dict[str, Any] = dict(), file_path: Optional[str] = None, path: Optional[str] = None, summary: Optional[str] = None, token_count: int = 0, timestamp: datetime = datetime.now())

Summary of a file's content.

Represents a condensed version of a file when the full content would exceed token limits. Contains sections, metadata, and instructions for AI assistants.

ATTRIBUTE	DESCRIPTION
content	Summarized content TYPE:str
was_summarized	Whether content was summarized TYPE:bool
original_tokens	Token count of original TYPE:int
summary_tokens	Token count of summary TYPE:int
original_lines	Line count of original TYPE:int
summary_lines	Line count of summary TYPE:int
preserved_sections	Sections that were preserved TYPE:List[str]
ignored_sections	Sections that were omitted TYPE:List[str]
sections	List of summary sections TYPE:List[SummarySection]
strategy	Strategy used for summarization TYPE:str
compression_ratio	Ratio of summary to original TYPE:float
instructions	Instructions for AI about summary TYPE:List[str]
metadata	Additional metadata TYPE:Dict[str, Any]
file_path	Original file path TYPE:Optional[str]
timestamp	When summary was created TYPE:datetime
Compatibility	TYPE:fields
-	legacy alias for file_path TYPE:path
-	legacy alias for content TYPE:summary
-	legacy alias for summary_tokens TYPE:token_count

Attributes

contentclass-attributeinstance-attribute

Python

content: str = ''

was_summarizedclass-attributeinstance-attribute

Python

was_summarized: bool = True

original_tokensclass-attributeinstance-attribute

Python

original_tokens: int = 0

summary_tokensclass-attributeinstance-attribute

Python

summary_tokens: int = 0

original_linesclass-attributeinstance-attribute

Python

original_lines: int = 0

summary_linesclass-attributeinstance-attribute

Python

summary_lines: int = 0

preserved_sectionsclass-attributeinstance-attribute

Python

preserved_sections: List[str] = field(default_factory=list)

ignored_sectionsclass-attributeinstance-attribute

Python

ignored_sections: List[str] = field(default_factory=list)

sectionsclass-attributeinstance-attribute

Python

sections: List[SummarySection] = field(default_factory=list)

strategyclass-attributeinstance-attribute

Python

strategy: str = 'extract'

compression_ratioclass-attributeinstance-attribute

Python

compression_ratio: float = 0.0

instructionsclass-attributeinstance-attribute

Python

instructions: List[str] = field(default_factory=list)

metadataclass-attributeinstance-attribute

Python

metadata: Dict[str, Any] = field(default_factory=dict)

file_pathclass-attributeinstance-attribute

Python

file_path: Optional[str] = None

pathclass-attributeinstance-attribute

Python

path: Optional[str] = None

summaryclass-attributeinstance-attribute

Python

summary: Optional[str] = None

token_countclass-attributeinstance-attribute

Python

token_count: int = 0

timestampclass-attributeinstance-attribute

Python

timestamp: datetime = field(default_factory=now)

Functions

add_instruction

Python

add_instruction(instruction: str) -> None

Add an instruction for the AI about this summary.

add_default_instructions

Python

add_default_instructions() -> None

Add default instructions based on summary characteristics.

add_metadata

Python

add_metadata(metadata: Dict[str, Any]) -> None

Add metadata about the summary.

add_section

Python

add_section(section: SummarySection) -> None

Add a section to the summary.

get_section

Python

get_section(name: str) -> Optional[SummarySection]

Get a specific section by name.

merge_sections

Python

merge_sections() -> str

Merge all sections into final content.

to_dict

Python

to_dict() -> Dict[str, Any]

Convert to dictionary representation.

from_dictclassmethod

Python

from_dict(data: Dict[str, Any]) -> FileSummary

Create from dictionary.

ProjectSummarydataclass

Python

ProjectSummary(name: str, description: str = '', structure: Dict[str, Any] = dict(), key_files: List[str] = list(), key_directories: List[str] = list(), technologies: List[str] = list(), frameworks: List[str] = list(), patterns: List[str] = list(), dependencies: List[str] = list(), statistics: Dict[str, Any] = dict(), recent_activity: Dict[str, Any] = dict(), team_info: Dict[str, Any] = dict(), metadata: Dict[str, Any] = dict(), timestamp: datetime = datetime.now())

Summary of an entire project.

High-level summary for initial context or overview, providing a bird's eye view of the project structure and characteristics.

ATTRIBUTE	DESCRIPTION
name	Project name TYPE:str
description	Project description TYPE:str
structure	Project structure overview TYPE:Dict[str, Any]
key_files	Most important files TYPE:List[str]
key_directories	Important directories TYPE:List[str]
technologies	Technologies used TYPE:List[str]
frameworks	Frameworks detected TYPE:List[str]
patterns	Architectural patterns detected TYPE:List[str]
dependencies	Key dependencies TYPE:List[str]
statistics	Project statistics TYPE:Dict[str, Any]
recent_activity	Recent development activity TYPE:Dict[str, Any]
team_info	Team/contributor information TYPE:Dict[str, Any]
metadata	Additional metadata TYPE:Dict[str, Any]
timestamp	When summary was created TYPE:datetime

Attributes

nameinstance-attribute

Python

name: str

descriptionclass-attributeinstance-attribute

Python

description: str = ''

structureclass-attributeinstance-attribute

Python

structure: Dict[str, Any] = field(default_factory=dict)

key_filesclass-attributeinstance-attribute

Python

key_files: List[str] = field(default_factory=list)

key_directoriesclass-attributeinstance-attribute

Python

key_directories: List[str] = field(default_factory=list)

technologiesclass-attributeinstance-attribute

Python

technologies: List[str] = field(default_factory=list)

frameworksclass-attributeinstance-attribute

Python

frameworks: List[str] = field(default_factory=list)

patternsclass-attributeinstance-attribute

Python

patterns: List[str] = field(default_factory=list)

dependenciesclass-attributeinstance-attribute

Python

dependencies: List[str] = field(default_factory=list)

statisticsclass-attributeinstance-attribute

Python

statistics: Dict[str, Any] = field(default_factory=dict)

recent_activityclass-attributeinstance-attribute

Python

recent_activity: Dict[str, Any] = field(default_factory=dict)

team_infoclass-attributeinstance-attribute

Python

team_info: Dict[str, Any] = field(default_factory=dict)

metadataclass-attributeinstance-attribute

Python

metadata: Dict[str, Any] = field(default_factory=dict)

timestampclass-attributeinstance-attribute

Python

timestamp: datetime = field(default_factory=now)

Functions

add_technology

Python

add_technology(tech: str) -> None

Add a detected technology.

add_framework

Python

add_framework(framework: str) -> None

Add a detected framework.

add_pattern

Python

add_pattern(pattern: str) -> None

Add a detected architectural pattern.

update_statistics

Python

update_statistics(key: str, value: Any) -> None

Update a statistic value.

to_markdown

Python

to_markdown() -> str

Generate markdown representation of project summary.

to_dict

Python

to_dict() -> Dict[str, Any]

Convert to dictionary representation.

from_dictclassmethod

Python

from_dict(data: Dict[str, Any]) -> ProjectSummary

Create from dictionary.

SummarySectiondataclass

Python

SummarySection(name: str, content: str, line_start: int = 0, line_end: int = 0, importance: float = 1.0, preserved_fully: bool = True, tokens: int = 0, metadata: Dict[str, Any] = dict())

A section within a file summary.

Represents a specific section of code that was extracted for inclusion in the summary.

ATTRIBUTE	DESCRIPTION
name	Section name (e.g., "imports", "class_definitions") TYPE:str
content	Section content TYPE:str
line_start	Starting line in original file TYPE:int
line_end	Ending line in original file TYPE:int
importance	Importance score (0-1) TYPE:float
preserved_fully	Whether section was preserved in full TYPE:bool
tokens	Token count for this section TYPE:int
metadata	Additional section metadata TYPE:Dict[str, Any]

Attributes

nameinstance-attribute

Python

name: str

contentinstance-attribute

Python

content: str

line_startclass-attributeinstance-attribute

Python

line_start: int = 0

line_endclass-attributeinstance-attribute

Python

line_end: int = 0

importanceclass-attributeinstance-attribute

Python

importance: float = 1.0

preserved_fullyclass-attributeinstance-attribute

Python

preserved_fully: bool = True

tokensclass-attributeinstance-attribute

Python

tokens: int = 0

metadataclass-attributeinstance-attribute

Python

metadata: Dict[str, Any] = field(default_factory=dict)

Functions

truncate

Python

truncate(max_tokens: int) -> SummarySection

Truncate section to fit within token limit.

to_dict

Python

to_dict() -> Dict[str, Any]

Convert to dictionary representation.

from_dictclassmethod

Python

from_dict(data: Dict[str, Any]) -> SummarySection

Create from dictionary.

SummaryStrategy

Bases: Enum

Strategies for summarizing files.

Attributes

TRUNCATEclass-attributeinstance-attribute

Python

TRUNCATE = 'truncate'

EXTRACTclass-attributeinstance-attribute

Python

EXTRACT = 'extract'

COMPRESSclass-attributeinstance-attribute

Python

COMPRESS = 'compress'

SEMANTICclass-attributeinstance-attribute

Python

SEMANTIC = 'semantic'

LLMclass-attributeinstance-attribute

Python

LLM = 'llm'

HYBRIDclass-attributeinstance-attribute

Python

HYBRID = 'hybrid'

Functions

get_defaultclassmethod

Python

get_default() -> SummaryStrategy

Get default summarization strategy.

get_priority

Python

get_priority() -> int

Get priority for strategy selection.

InjectionStrategydataclass

Python

InjectionStrategy(frequency: str = 'adaptive', position: str = 'strategic', max_per_context: int = 3, min_tokens_between: int = 1000)

Strategy for how a tenet should be injected.

Attributes

frequencyclass-attributeinstance-attribute

Python

frequency: str = 'adaptive'

positionclass-attributeinstance-attribute

Python

position: str = 'strategic'

max_per_contextclass-attributeinstance-attribute

Python

max_per_context: int = 3

min_tokens_betweenclass-attributeinstance-attribute

Python

min_tokens_between: int = 1000

Functions

should_inject

Python

should_inject(context_length: int, already_injected: int) -> bool

Determine if tenet should be injected.

Priority

Bases: Enum

Tenet priority levels.

Attributes

LOWclass-attributeinstance-attribute

Python

LOW = 'low'

MEDIUMclass-attributeinstance-attribute

Python

MEDIUM = 'medium'

HIGHclass-attributeinstance-attribute

Python

HIGH = 'high'

CRITICALclass-attributeinstance-attribute

Python

CRITICAL = 'critical'

weightproperty

Python

weight: float

Get numerical weight for priority.

Tenetdataclass

Python

Tenet(id: str = (lambda: str(uuid.uuid4()))(), content: str = '', priority: Priority = Priority.MEDIUM, category: Optional[TenetCategory] = None, status: TenetStatus = TenetStatus.PENDING, created_at: datetime = datetime.now(), instilled_at: Optional[datetime] = None, updated_at: datetime = datetime.now(), session_bindings: list[str] = list(), author: Optional[str] = None, metrics: TenetMetrics = TenetMetrics(), injection_strategy: InjectionStrategy = InjectionStrategy(), metadata: dict[str, Any] = dict())

A guiding principle for code development.

Tenets are persistent instructions that guide AI interactions to maintain consistency across multiple prompts and sessions.

ATTRIBUTE	DESCRIPTION
id	Unique identifier TYPE:str
content	The principle text TYPE:str
priority	Importance level TYPE:Priority
category	Classification category TYPE:Optional[TenetCategory]
status	Current status (pending, instilled, archived) TYPE:TenetStatus
created_at	When the tenet was created TYPE:datetime
instilled_at	When first instilled into context TYPE:Optional[datetime]
updated_at	Last modification time TYPE:datetime
session_bindings	Sessions this tenet applies to TYPE:list[str]
author	Who created the tenet TYPE:Optional[str]
metrics	Usage and effectiveness metrics TYPE:TenetMetrics
injection_strategy	How this tenet should be injected TYPE:InjectionStrategy
metadata	Additional custom data TYPE:dict[str, Any]

Example

tenet = Tenet( ... content="Always use type hints in Python code", ... priority=Priority.HIGH, ... category=TenetCategory.STYLE ... )

Attributes

idclass-attributeinstance-attribute

Python

id: str = field(default_factory=lambda: str(uuid4()))

contentclass-attributeinstance-attribute

Python

content: str = ''

priorityclass-attributeinstance-attribute

Python

priority: Priority = MEDIUM

categoryclass-attributeinstance-attribute

Python

category: Optional[TenetCategory] = None

statusclass-attributeinstance-attribute

Python

status: TenetStatus = PENDING

created_atclass-attributeinstance-attribute

Python

created_at: datetime = field(default_factory=now)

instilled_atclass-attributeinstance-attribute

Python

instilled_at: Optional[datetime] = None

updated_atclass-attributeinstance-attribute

Python

updated_at: datetime = field(default_factory=now)

session_bindingsclass-attributeinstance-attribute

Python

session_bindings: list[str] = field(default_factory=list)

authorclass-attributeinstance-attribute

Python

author: Optional[str] = None

metricsclass-attributeinstance-attribute

Python

metrics: TenetMetrics = field(default_factory=TenetMetrics)

injection_strategyclass-attributeinstance-attribute

Python

injection_strategy: InjectionStrategy = field(default_factory=InjectionStrategy)

metadataclass-attributeinstance-attribute

Python

metadata: dict[str, Any] = field(default_factory=dict)

Functions

instill

Python

instill() -> None

Mark tenet as instilled.

archive

Python

archive() -> None

Archive this tenet.

bind_to_session

Python

bind_to_session(session_id: str) -> None

Bind tenet to a specific session.

unbind_from_session

Python

unbind_from_session(session_id: str) -> None

Remove session binding.

applies_to_session

Python

applies_to_session(session_id: Optional[str]) -> bool

Check if tenet applies to a session.

should_inject

Python

should_inject(context_length: int, already_injected: int) -> bool

Determine if this tenet should be injected.

format_for_injection

Python

format_for_injection() -> str

Format tenet content for injection into context.

to_dict

Python

to_dict() -> dict[str, Any]

Convert to dictionary representation.

from_dictclassmethod

Python

from_dict(data: dict[str, Any]) -> Tenet

Create Tenet from dictionary.

TenetCategory

Bases: Enum

Common tenet categories.

Attributes

ARCHITECTUREclass-attributeinstance-attribute

Python

ARCHITECTURE = 'architecture'

SECURITYclass-attributeinstance-attribute

Python

SECURITY = 'security'

STYLEclass-attributeinstance-attribute

Python

STYLE = 'style'

PERFORMANCEclass-attributeinstance-attribute

Python

PERFORMANCE = 'performance'

TESTINGclass-attributeinstance-attribute

Python

TESTING = 'testing'

DOCUMENTATIONclass-attributeinstance-attribute

Python

DOCUMENTATION = 'documentation'

API_DESIGNclass-attributeinstance-attribute

Python

API_DESIGN = 'api_design'

ERROR_HANDLINGclass-attributeinstance-attribute

Python

ERROR_HANDLING = 'error_handling'

QUALITYclass-attributeinstance-attribute

Python

QUALITY = 'quality'

CUSTOMclass-attributeinstance-attribute

Python

CUSTOM = 'custom'

TenetCollectiondataclass

Python

TenetCollection(name: str, description: str = '', tenets: list[Tenet] = list(), created_at: datetime = datetime.now(), tags: list[str] = list())

A collection of related tenets.

Attributes

nameinstance-attribute

Python

name: str

descriptionclass-attributeinstance-attribute

Python

description: str = ''

tenetsclass-attributeinstance-attribute

Python

tenets: list[Tenet] = field(default_factory=list)

created_atclass-attributeinstance-attribute

Python

created_at: datetime = field(default_factory=now)

tagsclass-attributeinstance-attribute

Python

tags: list[str] = field(default_factory=list)

Functions

add_tenet

Python

add_tenet(tenet: Tenet) -> None

Add a tenet to the collection.

remove_tenet

Python

remove_tenet(tenet_id: str) -> bool

Remove a tenet by ID.

get_by_category

Python

get_by_category(category: TenetCategory) -> list[Tenet]

Get all tenets of a specific category.

get_by_priority

Python

get_by_priority(priority: Priority) -> list[Tenet]

Get all tenets of a specific priority.

to_dict

Python

to_dict() -> dict[str, Any]

Convert to dictionary representation.

TenetMetricsdataclass

Python

TenetMetrics(injection_count: int = 0, last_injected: Optional[datetime] = None, contexts_appeared_in: int = 0, compliance_score: float = 0.0, reinforcement_needed: bool = False)

Metrics for tracking tenet effectiveness.

Attributes

injection_countclass-attributeinstance-attribute

Python

injection_count: int = 0

last_injectedclass-attributeinstance-attribute

Python

last_injected: Optional[datetime] = None

contexts_appeared_inclass-attributeinstance-attribute

Python

contexts_appeared_in: int = 0

compliance_scoreclass-attributeinstance-attribute

Python

compliance_score: float = 0.0

reinforcement_neededclass-attributeinstance-attribute

Python

reinforcement_needed: bool = False

Functions

update_injection

Python

update_injection() -> None

Update metrics after injection.

TenetStatus

Bases: Enum

Tenet status in the system.

Attributes

PENDINGclass-attributeinstance-attribute

Python

PENDING = 'pending'

INSTILLEDclass-attributeinstance-attribute

Python

INSTILLED = 'instilled'

ARCHIVEDclass-attributeinstance-attribute

Python

ARCHIVED = 'archived'

Modules

• analysis - Analysis module
• context - Context module
• llm - Llm module
• summary - Summary module
• tenet - Tenet module