Extensible polyglot code analysis framework with a graph IR
Project description
graphlens
Extensible polyglot code analysis framework that parses source projects, normalizes their structure into a shared graph IR, and exposes it for dependency analysis, navigation, and code intelligence tooling.
Architecture
Repository → Language Adapter → GraphLens (IR) → Graph Backend
| Layer | Responsibility |
|---|---|
| Language Adapter | Parses source files, produces GraphLens |
| GraphLens | Typed nodes + directed relations (the IR) |
| Graph Backend | Persists or queries the graph (Neo4j, in-memory, …) |
Adapters are pure data producers — they never write to any backend. The graph is the only output.
Why graph IR?
- Language-agnostic — one shared model for Python, TypeScript, Rust, …
- Plugin-based adapters — each language is a separate package, registered via Python entry points
- Tree-sitter powered — all adapters use tree-sitter for CST parsing and exact span positions, combined with type-aware resolution (ty for Python, TypeScript Compiler API for TypeScript)
- Monorepo aware —
can_handle()andfind_*_roots()handle multi-language repos correctly - Deterministic node IDs — SHA-256 hash of
project::kind::qualified_name→ stable across re-scans
Installation
# Core library only (models, contracts, registry)
pip install graphlens
# Core + Python adapter
pip install "graphlens[python]"
# Core + TypeScript adapter
pip install "graphlens[typescript]"
# CLI (graphlens analyze / visualize / neo4j)
pip install "graphlens-cli[python]" # with Python adapter
pip install "graphlens-cli[all]" # Python + TypeScript + Neo4j
With uv:
uv add graphlens
uv add "graphlens[python]"
uv add "graphlens[typescript]"
uv add "graphlens-cli[all]"
Quick start
from pathlib import Path
from graphlens import adapter_registry
# Load and instantiate the Python adapter
adapter = adapter_registry.load("python")()
# Analyze a project — returns a GraphLens
graph = adapter.analyze(Path("./my-project"))
print(f"Nodes: {len(graph.nodes)}")
print(f"Relations: {len(graph.relations)}")
# Inspect nodes by kind
from graphlens import NodeKind
modules = [n for n in graph.nodes.values() if n.kind == NodeKind.MODULE]
classes = [n for n in graph.nodes.values() if n.kind == NodeKind.CLASS]
CLI (graphlens-cli)
Install graphlens-cli to get the graphlens entry point with three commands:
# Print node/relation statistics
graphlens analyze <project_root>
graphlens analyze ~/myrepo --lang python,typescript
# Interactive HTML graph viewer (opens in browser)
graphlens visualize <project_root>
graphlens visualize ~/myrepo --lang python --show-external --max-nodes 500
graphlens visualize . --output graph.html --no-open
# Export to Neo4j
graphlens neo4j <project_root> --uri bolt://localhost:7687 --user neo4j --password secret
graphlens neo4j . --wipe --batch-size 200
visualize — interactive HTML graph viewer
Produces a self-contained HTML file powered by vis.js and opens it in the browser.
| Flag | Description |
|---|---|
--lang auto|python|typescript|python,typescript |
Adapters to use (default: auto-detect all) |
--show-external |
Include stdlib / third-party external symbol nodes |
--show-structure |
Add CONTAINS / DECLARES structural edges |
--max-nodes N |
Prune low-degree nodes above N (default: 1500) |
--output PATH |
Write HTML to PATH instead of graph-<name>.html |
--no-open |
Do not open the browser automatically |
Click behaviour — click any node to see its info panel. For FUNCTION
and METHOD nodes the panel has a "Show callers" button that switches the
graph into focus mode: only the selected node and every node that calls or
references it are shown, with the caller list in the sidebar. Click empty
space or ← Back to return to the full graph.
neo4j — export to Neo4j
Uses UNWIND … MERGE Cypher (no APOC required). Every node gets a :Code
label plus a kind-specific label (:Function, :ExternalSymbol, …).
Relations are created grouped by type. Install the optional neo4j extra:
pip install "graphlens-cli[neo4j]"
Graph model
Node kinds
| Kind | Description |
|---|---|
PROJECT |
Root project node |
MODULE |
Python/TS/… module (directory or file) |
FILE |
Source file |
CLASS |
Class declaration |
FUNCTION |
Top-level function |
METHOD |
Method inside a class |
PARAMETER |
Function/method parameter |
VARIABLE |
Module-level or local variable |
ATTRIBUTE |
Class attribute |
TYPE_ALIAS |
Type alias declaration |
IMPORT |
Import statement |
DEPENDENCY |
Declared package dependency |
EXTERNAL_SYMBOL |
External symbol (stdlib, third-party, or unknown); carries metadata["origin"] |
Relation kinds
| Kind | Description |
|---|---|
CONTAINS |
Structural containment (project → module → file → class) |
DECLARES |
Declaration (file declares function, class declares method) |
IMPORTS |
Import edge (file → import node) |
RESOLVES_TO |
Import resolved to a module or external symbol |
CALLS |
Function/method call (resolved to declaration node) |
REFERENCES |
Value reference (variable/attribute used as a value) |
INHERITS_FROM |
Class inheritance (resolved to declaration node) |
HAS_TYPE |
Type annotation/inference edge (function/param/variable → class or external) |
DEPENDS_ON |
Package dependency |
Adapter plugin system
Language adapters register themselves via Python entry points — no changes to the core needed:
# packages/graphlens-python/pyproject.toml
[project.entry-points."graphlens.adapters"]
python = "graphlens_python:PythonAdapter"
The registry discovers installed adapters automatically at runtime:
from graphlens import adapter_registry
adapter_registry.available() # ["python", ...]
adapter_cls = adapter_registry.load("python")
adapter = adapter_cls()
Adapters can also be registered manually (useful for testing):
adapter_registry.register("python", MyPythonAdapter)
Implementing an adapter
Subclass LanguageAdapter and implement four methods:
from pathlib import Path
from graphlens import GraphLens, LanguageAdapter
class MyLangAdapter(LanguageAdapter):
def language(self) -> str:
return "mylang"
def file_extensions(self) -> set[str]:
return {".ml", ".mli"}
def can_handle(self, project_root: Path) -> bool:
return (project_root / "dune-project").exists()
def analyze(
self, project_root: Path, files: list[Path] | None = None
) -> GraphLens:
graph = GraphLens()
files = files or self.collect_files(project_root)
# ... parse and populate graph ...
return graph
Register in pyproject.toml and the core registry finds it automatically.
Project structure
graphlens/ ← uv workspace root (core library)
src/graphlens/ ← models, contracts, registry, exceptions, utils
packages/
graphlens-python/ ← Python adapter (tree-sitter + ty)
graphlens-typescript/ ← TypeScript adapter (tree-sitter + Compiler API)
graphlens-cli/ ← CLI package (typer): analyze, visualize, neo4j
tests/ ← core tests (100% coverage)
examples/ ← standalone usage examples
Development
Requires Python 3.13+, uv, task.
task install # uv sync --all-groups
task lint # ruff + ty + bandit for all packages
task tests # all tests with coverage
Individual package tasks:
task core:lint task core:test
task python:lint task python:test
task typescript:lint task typescript:test
task cli:lint task cli:test
License
MIT
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file graphlens-0.4.0.tar.gz.
File metadata
- Download URL: graphlens-0.4.0.tar.gz
- Upload date:
- Size: 12.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: uv/0.11.23 {"installer":{"name":"uv","version":"0.11.23","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
301543f4815b80204c366459bf1cb620403da7d57c7c4106d8bae6931c5ea1ce
|
|
| MD5 |
e88c0b2c2c7b5cc7d60dd27707d3da06
|
|
| BLAKE2b-256 |
3bef3b22e3612e1fe3da20d36f3684664ad96123bee907faec47d65429061470
|
File details
Details for the file graphlens-0.4.0-py3-none-any.whl.
File metadata
- Download URL: graphlens-0.4.0-py3-none-any.whl
- Upload date:
- Size: 18.7 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: uv/0.11.23 {"installer":{"name":"uv","version":"0.11.23","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
297afcce608c84d2e777a16bd20681596b5ec977ce9dfa5498d4601426240a6b
|
|
| MD5 |
0344297333cc6da176d6ba790a59a6b5
|
|
| BLAKE2b-256 |
86a0b3b9c64f944c027e0023b2a8eb23811773f21e0a3887748d6f4f72c8eaeb
|