Skip to content

architecture.md

Latest commit

 

History

History
30 lines (21 loc) · 1.89 KB

architecture.md

File metadata and controls

30 lines (21 loc) · 1.89 KB
Raw

Architecture of the Python SDK

This page is for contributors who change the SDK. Users start at the README.

The CLDK factories in core.py are the entry point. A factory validates its arguments. It selects a backend by the type of the backend= configuration. It then returns the analysis facade for the language. Each language package has two parts: data models and an analysis backend.

graph TD
    Agent <--> CLDK
    CLDK --> M[cldk.models<br/>typed Pydantic schemas]
    CLDK --> A[cldk.analysis]

    A --> J[cldk.analysis.java]
    A --> P[cldk.analysis.python]
    A --> T[cldk.analysis.typescript]

    J --> EJ[codeanalyzer-java<br/>JavaParser · WALA]
    P --> EP[codeanalyzer-python<br/>Jedi · ast · Scalpel]
    T --> ET[codeanalyzer-typescript<br/>TypeScript compiler · RTA · def-use linker]

    J -. read-only .-> N[(Neo4j)]
    P -. read-only .-> N
    T -. read-only .-> N
Loading

Data models live under cldk.models.<language>. They mirror canonical schema v2 as Pydantic models for modules, types, callables, fields, statements, artifacts, and dependencies. The projections (*CallableOverview, *ClassOverview) are the lightweight forms the bulk accessors return.

Analysis backends live under cldk.analysis.<language>. A shared AnalysisBackend ABC in cldk.analysis.commons declares the core accessors and the artifact, dependency, and configuration accessors. Each language subclasses it once for the local analyzer and once for Neo4j. The local backend runs the analyzer and maps its output onto the models. The Neo4j backend reconstructs the same models from the graph. Both backends therefore answer the same accessors.

Shared result types live in cldk.analysis.commons.results and cldk.analysis.commons.bounds: LocateResult, EdgePage, Slice, FlowPaths, TaintResult, EntrypointCoverage, Diagnostic, and the default bounds.