Python API Reference

This section contains the Python API documentation for dftracer utilities.

Python Modules:

• TraceReader Module
  • TraceReader Class
  • Streaming Iterators
  • Arrow Output
  • Writing Arrow IPC Files
  • File Metadata
  • Query Filtering
  • ReadConfig Parameters
• Utilities Module
  • Tabular Utilities (Arrow Output)
  • Scalar Utilities (Dict Output)
  • Arrow Data Types
• Runtime Module
  • Runtime Class
  • TaskHandle Class
  • Module-level Functions
  • Submitting Tasks
  • Error Handling
  • Progress Tracking
  • Dask Integration
• JSON Module
  • JsonDictValue Class
• Indexer Module
  • Indexer Class
  • CheckpointIndexer Class
  • IndexerCheckpoint Class
  • Distributed Index (SST-based)
  • Module-level Functions
  • Dask Helpers
• DFAnalyzer Module
  • Index Building
  • Arrow IPC Marshalling
  • Distributed High-Level Metrics
  • View Groupby Partials
  • Dtype Coercion

Module Overview

The dftracer utilities Python package provides the following main modules:

• TraceReader Module - Streaming trace file reader with JSON and Arrow support

• Utilities Module - Utility bindings (statistics, views, aggregation, bloom queries)

• Runtime Module - Coroutine runtime and Dask integration

• JSON Module - Lazy JSON object type

• Indexer Module - Indexing and searching capabilities

• DFAnalyzer Module - dfanalyzer bridge: index build, Arrow IPC, distributed HLM