Skip to main content

LangAdapter

PyPI version Python versions License: MIT Documentation

LangAdapter gives a Python program one common interface to software projects in different programming languages. With the same calls, a program can read and edit a project's source code, check what the project's setup supports, and run its tests with coverage, mutation and timing measurements. Python, Java and C come with it, and it is built to be extended: a new language is one file with its adapter class, and code metrics and tool installers are added the same way, with no change to the library. LangAdapter needs no language model.

Supported systems

Projects in Windows Linux macOS
Python yes yes expected to work
Java yes yes expected to work
C in WSL yes not yet supported

LangAdapter was tested on Windows 11, Ubuntu 24.04 under WSL and AlmaLinux 8.10. On Windows and Linux it confirms that a command and everything it started have ended. This release has not run on a Mac. On macOS and other POSIX systems it runs each command in its own process group and cannot confirm that every descendant ended, so it warns and records that in its observations. On Windows, C projects run with LangAdapter installed inside WSL. Python and Java projects can also run in a running Linux container you provide. Tested environments says what is known.

Install

The library needs Python 3.10 or newer. Install it into the Python environment of the program that uses it, such as a virtual environment. On Ubuntu 24.04, also in WSL, Python is python3, and a virtual environment needs the package python3-venv:

sudo apt-get install python3-venv
python3 -m venv .venv
.venv/bin/python -m pip install langadapter

On Windows:

py -m venv .venv
.venv\Scripts\python -m pip install langadapter

In a source checkout, .venv/bin/python -m pip install . installs it from the checkout. For C projects, install it with the extra for C: .venv/bin/python -m pip install "langadapter[c]". On Windows the environment's Python is .venv\Scripts\python.

The project under test keeps its own runtime and tools, which Getting started names for each language. On Ubuntu 24.04 on x86_64, langadapter toolchains installs them, as Install the toolchains describes.

Example

Run a Python project's tests with the project's interpreter and read the result:

import langadapter as la
from langadapter.runs import SuiteRunRequest

project = "path/to/project"
project_python = "path/to/project/.venv/bin/python"  # path/to/project/.venv/Scripts/python.exe on Windows
context = la.ProjectContext(root=project, interpreter=la.Interpreter(path=project_python))
adapter = la.create("python", context)
suite = la.Suite(project, ("tests/test_example.py",))
result = adapter.tests.run_suite(SuiteRunRequest(suite, timeout_s=120))
print(result.outcome, result.counts.passed, "passed")

If the project has a conftest.py in its directory or in tests, list it as a setup file, for example la.Suite(project, ("tests/test_example.py",), ("tests/conftest.py",)). A run refuses a suite that leaves out a setup file pytest would load.

Every result carries an outcome such as completed, test_failures, missing_setup or unsupported, and a reason, as Outcomes describes.

Documentation

The documentation site is https://k-kammler.github.io/langadapter/.

The guides also cover containers, source analysis and settings, and the explanations cover outcomes, prepared copies of a project and environment selection. The guides are also in the repository's docs directory and installed with the package under share/doc/langadapter/docs, without the API reference, which is on the site only: in the installed copy, Python's help() shows each name's documentation. Building the site yourself is described in CONTRIBUTING.md. What the library depends on and downloads, with each license, is in THIRD_PARTY_NOTICES.md.

License

MIT, see LICENSE.

Metadata

Release files for langadapter 0.1.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for langadapter 0.1.1
File Size Uploaded Provenance Actions
langadapter-0.1.1.tar.gz 907.7 kB Without provenance Details for langadapter-0.1.1.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for langadapter 0.1.1
File Interpreter ABI Platform Actions
langadapter-0.1.1-py3-none-any.whl Python 3 none any Details for langadapter-0.1.1-py3-none-any.whl

Total release size: 1.9 MB

Release files / langadapter-0.1.1.tar.gz

Download URL langadapter-0.1.1.tar.gz
Size 907.7 kB
Tags Source
SHA-256 checksum
How to use checksums
d399f03526a10104e4b6bef6a0a0af7c8e74a6845d0880d70d56de7835db6771
BLAKE2b-256 checksum
How to use checksums
80b8ba6d55a9adf2a862924bc98c551a9ea40d3ad8e138897b62f8c2896664c4
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.12.10

Release files / langadapter-0.1.1-py3-none-any.whl

Download URL langadapter-0.1.1-py3-none-any.whl
Size 1.0 MB
Tags Python 3
SHA-256 checksum
How to use checksums
7310a0eed078b7a29544d4f960bee7e66ddfcbfc7636ad823bae70b1e7c23c34
BLAKE2b-256 checksum
How to use checksums
738238656005c2cc99235d1689216ba5946226af46e459817771cfe07f3c1ead
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.12.10

Security for langadapter 0.1.1

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

0.1.1 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page