Skip to main content

AutoDef: LLM functions

Project description

🤖 AutoDef

AutoDef is a Python library that leverages Large Language Models (LLMs) to automatically implement, execute, and repair functions at runtime. It transforms docstrings into executable code, providing a seamless bridge between declarative intent and imperative execution.

✨ Key Features

  • @impl Decorator: Automatically generates function bodies from docstrings and type hints.
  • @llm Decorator: Directly routes function calls to an LLM, supporting raw text and structured Pydantic responses.
  • @shim Decorator: Intelligent error recovery that automatically repairs failing functions at runtime.
  • 📦 Smart Caching: Generated code is persisted locally, ensuring stability, predictability, and performance.
  • 🔍 Context Awareness: Automatically includes local file context and type definitions in prompts.
  • 🖼️ Multimodal Support: Seamlessly handle images and file paths as function arguments.

🚀 Quick Start

Installation

pip install autodef

Note: Requires Python 3.12 or higher.

Configuration

AutoDef works with any OpenAI-compatible API. Configure it via environment variables:

By default, local models will be used if available.

export AUTODEF_API_KEY="your-api-key"
export AUTODEF_BASE_URL="https://api.openai.com/v1"
export AUTODEF_MODEL="gpt-5"
exprt AUTODEF_CACHE_DIR=".autodef_cache"  # Optional, defaults to .autodef_cache

🛠️ Usage Examples

1. Automatic Implementation (@impl)

Turn a description into code instantly. The implementation is generated once, cached, and reused.

from autodef import impl

@impl
def get_weather_advice(celsius: float) -> str:
    """
    Returns a string advice based on the temperature.
    Use emoji and be friendly.
    """
    ...

print(get_weather_advice(25.5)) 
# Output: "It's a beautiful 25.5°C! Perfect for a walk. ☀️"

2. LLM-Backed Functions (@llm)

For tasks requiring natural language reasoning or multimodal input.

from autodef import llm
from pydantic import BaseModel
from pathlib import Path

class Summary(BaseModel):
    title: str
    key_points: list[str]

@llm
def summarize_report(file_path: Path) -> Summary:
    """Summarize the provided report file."""
    ...

# AutoDef automatically reads the file content and sends it to the LLM
report_summary = summarize_report(Path("report.txt"))

3. Self-Healing Code (@shim)

Automatically recover from runtime errors using LLM-generated fixes.

from autodef import shim

@shim
def parse_config(raw_data: str) -> dict:
    # This might fail if raw_data is malformed
    import json
    return json.loads(raw_data)

# If json.loads fails, @shim will ask the LLM to 
# provide a fix (before, after, or a full rewrite).
data = parse_config("{ invalid json }")

🧪 Development & Release

Testing

This project uses uv for dependency management and aw for script execution, install using npm install -g @7obygit/aw. You can run all standard checks (linting, type checking, and tests) using the provided helper script:

aw run check  # Runs ./.aw/check.sh

Alternatively, you can run them manually:

uv sync --dev
uv run ruff check .
uv run mypy .
uv run pytest

Releasing to PyPI

Releases are automated via GitHub Actions using Python Semantic Release.

To trigger a new release:

  1. Commit your changes using Conventional Commits (e.g., feat: add new feature, fix: resolve bug).
  2. Merge your changes to the main branch with a PR.
  3. The GitHub Action will automatically:
    • Determine the next version number.
    • Update pyproject.toml and src/autodef/__init__.py.
    • Generate a changelog.
    • Create a GitHub Release with the updated version tag.
    • Build and publish the package to PyPI.

🧠 How it Works

  1. Analysis: AutoDef inspects function signatures, type hints, and docstrings.
  2. Prompting: It constructs a prompt with codebase context, including relevant source code and type definitions.
  3. Generation: The LLM generates a robust Python implementation.
  4. Persistence: The code is cached in .autodef_cache/, giving you full visibility and control over what runs in your environment.

📝 License

Distributed under the MIT License. See LICENSE for more information.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

autodef-0.3.1.tar.gz (77.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

autodef-0.3.1-py3-none-any.whl (18.9 kB view details)

Uploaded Python 3

File details

Details for the file autodef-0.3.1.tar.gz.

File metadata

  • Download URL: autodef-0.3.1.tar.gz
  • Upload date:
  • Size: 77.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for autodef-0.3.1.tar.gz
Algorithm Hash digest
SHA256 d0bbea4d46ef01663d58e8f3a9342ffae262ec02bdd33ad726a4b4cfc02f2409
MD5 5b6deef6ff64593b03a6f3db5ea73e0d
BLAKE2b-256 6f554d5418ec1ee95f93bb9cc6f01bf802cc2423ece433f5203308841a403f8a

See more details on using hashes here.

Provenance

The following attestation bundles were made for autodef-0.3.1.tar.gz:

Publisher: release.yml on 7obyGit/AutoDef

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file autodef-0.3.1-py3-none-any.whl.

File metadata

  • Download URL: autodef-0.3.1-py3-none-any.whl
  • Upload date:
  • Size: 18.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for autodef-0.3.1-py3-none-any.whl
Algorithm Hash digest
SHA256 ec5e1a5bc4bde0ba870a547d9a1cd54235efc449a4ac589fdbe1ac4629416437
MD5 ab9a0a92fed8be1513c61316250dbca6
BLAKE2b-256 c8ce93d560e6d853ba104902bfebc7788e652891e192f874882bc3b945ac37fc

See more details on using hashes here.

Provenance

The following attestation bundles were made for autodef-0.3.1-py3-none-any.whl:

Publisher: release.yml on 7obyGit/AutoDef

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page