trilogy-parser 0.3.310

Parser and import/datasource dependency resolver for the Trilogy language
Documentation

Trilogy Parser (trilogy-parser)

A Rust-based CLI tool and Python library for parsing PreQL (Trilogy) files and resolving import dependencies with ETL-aware dependency ordering.

Features

  • Parse PreQL files to extract imports, datasource declarations, and persist statements
  • Resolve import dependencies transitively
  • Build dependency graphs with ETL-aware ordering:
    • Files that persist (write) to a datasource run before files that declare it, even if they import it.
    • Standard import dependencies (imported files run before importing files)

Exit codes:

  • 0: Success
  • 1: Error (parse error, file not found, circular dependency, etc.)

CLI Usage

Parse a single file

trilogy-parser-cli parse path/to/file.preql --format pretty

Parse a directory

trilogy-parser-cli parse path/to/directory --recursive --format json

Resolve dependencies

trilogy-parser-cli resolve path/to/file.preql --format pretty

Analyze datasources

trilogy-parser-cli datasources path/to/directory --recursive

Python Integration

The Rust resolver is integrated into the Python package via PyO3 and maturin.

Building the Python Extension

cd trilogy/scripts/dependency
maturin develop  # For development
# or
maturin build --release  # For production
pip install target/wheels/*.whl

Using in Python

from trilogy.scripts.dependency import DependencyResolver, ETLDependencyStrategy, create_script_nodes
from pathlib import Path

# Create script nodes from files
files = [Path("model1.preql"), Path("model2.preql")]
nodes = create_script_nodes(files)

# Use the ETL dependency strategy (backed by Rust)
resolver = DependencyResolver(strategy=ETLDependencyStrategy())
graph = resolver.build_graph(nodes)

# Get execution order (graphs use the Rust-backed graph facade;
# nodes are script-path strings)
from trilogy.core import graph as nx
execution_order = list(nx.topological_sort(graph))

The ETLDependencyStrategy uses the Rust-based resolver under the hood for fast, accurate dependency analysis based on:

  • Import statements
  • Datasource declarations
  • Persist statements (append/overwrite/persist)

Development

Running Rust Tests

cd trilogy/scripts/dependency
cargo test

All tests include:

  • Unit tests for parser (17 tests covering imports, datasources, persist statements)
  • Unit tests for resolver (5 tests covering dependency resolution logic)
  • Integration tests for CLI (12 tests covering all CLI commands)

Building the CLI

cargo build --release

The binary will be at target/release/trilogy-parser-cli (or .exe on Windows).

Building for Python

Run maturin from the base of the pytrilogy repo. [not this directory.]

# Development mode (installs in current Python environment)
maturin develop

# Production build
maturin build --release

# The wheel will be in target/wheels/

Dependency Ordering Rules

The resolver implements three key dependency rules:

  1. Import Dependencies : Imported files should run before importing files
  2. Persist-Before-Declare: Files that persist to a datasource must run before files that declare it, even if they import that file.

Edge Cases

  • Case 1: file A imports from file B → B must run before A for all datasources in B
  • Case 2: file A imports from file B, then updates datasource from file B → update takes precedence, so A runs before B.

Grammar Limitations

The grammar is currently focused on dependency-relevant constructs (imports, datasources, persist statements). It does not parse all Trilogy syntax. It can be extended in the future.