Skip to content

Reference

The reference is generated from the modules below and their docstrings. Modules whose names start with an underscore are internal and not listed. As files in the repository, the module pages hold only the module names the site renders into their texts. A name langadapter itself exports, such as langadapter.Outcome, has its entry on the Core page, and the page of the module that defines it does not render it again. What users need from langadapter.suites, langadapter.context, langadapter.operations, langadapter.preparation and langadapter.cancellation is on the Core page. The packages langadapter.python, langadapter.java and langadapter.c hold their adapters' modules, which the Python, Java and C pages render. langadapter.tutorial.language and langadapter.tutorial.example hold the Toy language that langadapter tutorial writes out and explains step by step. Tested environments lists the platforms, Python versions and language tools LangAdapter was tested with, each with the release of its test.

Page Modules
Core langadapter: contexts, suites, registration, setup checks and the operation groups (SourceOperations, TestOperations, MutationOperations), plus langadapter.errors and langadapter.execution
Runs langadapter.runs: requests and results of test operations, warmed suite timing included
Outcomes and identity langadapter.outcomes: outcomes, identities and observation records
Setup and capabilities langadapter.setup, langadapter.capabilities
Mutation langadapter.mutation: requests, runs, sessions, per-suite runs, resolutions, evidence, outcomes and kill matrices
Sources langadapter.sources: source operations, pools and structural metrics
Python the Python adapter, with Cosmic Ray settings and kill attribution (langadapter.python.cosmic_ray), pytest options, the directory of an interpreter environment inside the project, bytecode and suite setup (langadapter.python.project), and source analysis and repair (langadapter.python.source_analysis)
Java the Java adapter and its source analysis
C the C adapter (langadapter.c.adapter): CAdapter and its runner options CRunOptions
Extending langadapter.adapter, langadapter.registry, langadapter.conformance, langadapter.check, langadapter.consumers, langadapter.versions, langadapter.vocabulary, langadapter.templates, langadapter.treesitter, the hook table's module (langadapter.hooks), the command line (langadapter.cli) and the tutorial (langadapter.tutorial)
Machine resources langadapter.resources: the processors a process may run on, and a line of memory use and load for a progress log
Timing placement langadapter.placement: one benchmark at a time in a process, and the launcher of a timing process
Hooks and facts langadapter.hooks: every fact and hook an adapter can provide, with what it enables and what to write
Commands langadapter.cli.parser: every command of langadapter with its arguments and options