lean-interact 0.7.0__tar.gz → 0.8.0__tar.gz

lean_interact-0.8.0/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,24 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: "[BUG]"
+labels: ''
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Your environment:
+- OS: Linux, macOS, Windows, ...
+- Python version
+- LeanInteract version (`pip show lean-interact`)
+Then the steps to reproduce the behavior.
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Additional context**
+Add any other context about the problem here.

lean_interact-0.8.0/.github/copilot-instructions.md

@@ -0,0 +1,134 @@
+# LeanInteract AI Coding Guidelines
+
+## Project Overview
+LeanInteract is a Python package that provides a high-level interface to the Lean 4 theorem prover through the Lean REPL. It abstracts project setup, dependency management, and REPL communication to enable seamless Lean-Python integration for theorem proving, autoformalization, and mathematical verification tasks.
+
+## Architecture Overview
+
+### Core Components
+- **Projects**: Self-contained Lean project configurations that handle their own setup and building
+- **REPL Configuration**: Manages REPL-specific settings
+- **Servers**: Thread-safe wrappers around Lean REPL processes with async support
+- **Interface**: Pydantic models for type-safe communication with Lean REPL
+
+### Project Instantiation Pattern
+```python
+# Projects are instantiated independently and passed to config
+project = TempRequireProject(lean_version="v4.8.0", require="mathlib")
+config = LeanREPLConfig(project=project)
+```
+
+### Key Project Types
+- `LocalProject(directory="path")`: Existing local Lean projects
+- `GitProject(url="...", rev="...")`: Auto-cloning git repositories
+- `TempRequireProject(lean_version="...", require=[...])`: Temporary projects with dependencies
+- `TemporaryProject(lean_version="...", content="...")`: Custom lakefile content
+
+## Critical Development Patterns
+
+### File Locking for Concurrency
+All project operations use `FileLock(f"{directory}.lock")` to prevent race conditions during setup:
+```python
+with FileLock(f"{directory}.lock"):
+    # Setup operations here
+```
+
+### Environment State Management
+Commands return `CommandResponse` with `env` field for chaining:
+```python
+result1 = server.run(Command(cmd="def x := 1"))
+result2 = server.run(Command(cmd="def y := x + 1", env=result1.env))
+```
+
+### Thread-Safe Server Operations
+Both sync and async operations use internal locking:
+```python
+# Synchronous
+result = server.run(Command(cmd="..."))
+# Asynchronous
+result = await server.async_run(Command(cmd="..."))
+```
+
+## Testing Conventions
+
+### Configuration Setup
+Always pre-instantiate config for multiprocessing tests:
+```python
+@classmethod
+def setUpClass(cls):
+    cls.config = LeanREPLConfig(cache_dir=tempfile.mkdtemp())
+```
+
+### Concurrency Testing
+Use `mp.get_context("spawn")` for cross-platform process spawning and proper timeout handling:
+```python
+ctx = mp.get_context("spawn")
+p = ctx.Process(target=worker_func, args=(config,))
+p.start()
+p.join(timeout=60)
+```
+
+### First-Time Setup Timeouts
+Initial Lean setup can take minutes - use generous timeouts (60s+) for setup-related tests.
+
+## Build & Development Workflow
+
+### Essential Commands
+- **All scripts, tests, and commands should be run using [`uv`](https://github.com/astral-sh/uv) for speed and reproducibility.**
+- **Tests are run with the standard `unittest` framework, not pytest.**
+
+```bash
+# Setup: Install with dev dependencies
+uv pip install -e ".[dev]"
+
+# Testing: Run all tests with unittest
+uv run python -m unittest discover tests
+# Or run a specific test module
+uv run python -m unittest tests/test_server.py
+uv run python -m unittest tests/test_concurrency.py
+
+# Documentation: Local preview
+uv run mkdocs serve
+
+# Cache management
+uv run clear-lean-cache  # Clear all cached projects
+```
+
+### Project Structure
+- `src/lean_interact/`: Core package modules
+- `tests/`: Comprehensive test suite with concurrency tests
+- `examples/`: Real-world usage examples (autoformalization, benchmarks)
+- `docs/`: MkDocs documentation with API reference
+
+## Integration Patterns
+
+### Error Handling
+Commands can return `LeanError` instead of `CommandResponse`:
+```python
+result = server.run(command)
+if isinstance(result, LeanError):
+    # Handle error
+elif isinstance(result, CommandResponse):
+    # Process successful result
+```
+
+### Memory Management
+Set memory limits for Linux platforms:
+```python
+config = LeanREPLConfig(memory_hard_limit_mb=4096)
+```
+
+### Session Caching
+Use `AutoLeanServer` for automatic session state management across commands.
+
+## External Dependencies
+- **Lean 4**: Managed via `elan` toolchain, versions v4.8.0+ supported
+- **Lake**: Lean's build system, used for project initialization and building
+- **Git**: Required for project cloning and REPL setup
+- **FileSystem**: Heavy use of file locking, temp directories, and path manipulation
+
+## Common Pitfalls
+- Don't pass `lean_version` when providing a `project` - version is inferred from project
+- Use absolute paths for all file operations
+- First-time project setup requires internet access and can be slow
+- Concurrency tests may timeout on slow systems due to Lean compilation

{lean_interact-0.7.0 → lean_interact-0.8.0}/.github/workflows/ci.yml

@@ -63,4 +63,4 @@ jobs:
 
       - name: Build documentation
         if: runner.os == 'Linux'
-        run: mkdocs build
+        run: clear-lean-cache && mkdocs build

lean_interact-0.8.0/.github/workflows/docs.yml

@@ -0,0 +1,113 @@
+name: Deploy Documentation
+
+on:
+  push:
+    branches:
+      - main
+    paths:
+      - 'docs/**'
+      - 'mkdocs.yml'
+      - 'src/lean_interact/**'
+      - '.github/workflows/docs.yml'
+    tags:
+      - 'v*' # Deploy on version tags
+  workflow_dispatch:
+    inputs:
+      version:
+        description: 'Version to deploy (e.g., v0.7.0, latest, dev)'
+        required: false
+        default: 'dev'
+      alias:
+        description: 'Alias for this version (e.g., stable, latest)'
+        required: false
+
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+permissions:
+  contents: write
+  pages: write
+  id-token: write
+
+# Allow only one concurrent deployment
+concurrency:
+  group: 'pages'
+  cancel-in-progress: false
+
+jobs:
+  build-and-deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0 # Full history for mike
+
+      - name: Setup Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.10'
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v4
+        with:
+          version: "latest"
+
+      - name: Install dependencies
+        run: |
+          uv venv
+          uv pip install -e ".[dev]"
+
+      - name: Install Lean
+        run: |
+          uv run install-lean
+          echo "$HOME/.elan/bin" >> $GITHUB_PATH
+
+      - name: Configure Git
+        run: |
+          git config --global user.name "github-actions[bot]"
+          git config --global user.email "github-actions[bot]@users.noreply.github.com"
+
+      - name: Fetch gh-pages branch
+        run: |
+          git fetch origin gh-pages --depth=1 || echo "gh-pages branch doesn't exist yet"
+
+      - name: Generate changelog
+        run: |
+          uv run python docs/generate_changelog.py
+
+      - name: Determine version and alias
+        id: version
+        run: |
+          if [[ "${{ github.event_name }}" == "workflow_dispatch" ]]; then
+            VERSION="${{ github.event.inputs.version }}"
+            ALIAS="${{ github.event.inputs.alias }}"
+          elif [[ "${{ github.ref }}" == refs/tags/v* ]]; then
+            VERSION="${{ github.ref_name }}"
+            # Only set stable for release versions (not pre-release)
+            if [[ "${{ github.ref_name }}" =~ ^v[0-9]+\.[0-9]+\.[0-9]+$ ]]; then
+              ALIAS="stable"
+            else
+              ALIAS=""  # Pre-release versions don't get stable alias
+            fi
+          elif [[ "${{ github.ref }}" == "refs/heads/main" ]]; then
+            VERSION="dev"
+            ALIAS=""
+          else
+            VERSION="dev"
+            ALIAS=""
+          fi
+
+          echo "version=$VERSION" >> $GITHUB_OUTPUT
+          echo "alias=$ALIAS" >> $GITHUB_OUTPUT
+          echo "Deploying version: $VERSION with alias: $ALIAS"
+
+      - name: Deploy with mike
+        run: |
+          if [[ -n "${{ steps.version.outputs.alias }}" ]]; then
+            uv run mike deploy --push --update-aliases ${{ steps.version.outputs.version }} ${{ steps.version.outputs.alias }}
+            # Set default version if this is a stable release
+            if [[ "${{ steps.version.outputs.alias }}" == "stable" ]]; then
+              uv run mike set-default --push stable
+            fi
+          else
+            uv run mike deploy --push ${{ steps.version.outputs.version }}
+          fi

{lean_interact-0.7.0 → lean_interact-0.8.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: lean-interact
-Version: 0.7.0
+Version: 0.8.0
 Summary: LeanInteract is a Python package that allows you to interact with the Lean theorem prover.
 Author-email: Auguste Poiroux <auguste.poiroux@epfl.ch>
 License: MIT License
@@ -38,7 +38,7 @@ Description-Content-Type: text/markdown
 
 # LeanInteract
 
-[![Docs](https://img.shields.io/badge/docs-latest-blue.svg)](https://augustepoiroux.github.io/LeanInteract/)
+[![Documentation](https://img.shields.io/badge/docs-latest-purple.svg)](https://augustepoiroux.github.io/LeanInteract/)
 [![PyPI version](https://img.shields.io/pypi/v/lean-interact.svg)](https://pypi.org/project/lean-interact/)
 [![PyPI downloads](https://img.shields.io/pepy/dt/lean-interact.svg)](https://pypi.org/project/lean-interact/)
 [![Python 3.10+](https://img.shields.io/badge/python-3.10+-blue.svg)](https://www.python.org/downloads/)
@@ -46,12 +46,14 @@ Description-Content-Type: text/markdown
 
 **LeanInteract** is a Python package designed to seamlessly interact with Lean 4 through the [Lean REPL](https://github.com/leanprover-community/repl).
 
+Check the [documentation](https://augustepoiroux.github.io/LeanInteract/) for detailed usage and examples.
+
 ## Key Features
 
 - **🔗 Interactivity**: Execute Lean code and files directly from Python.
 - **🚀 Ease of Use**: LeanInteract abstracts the complexities of Lean setup and interaction.
 - **💻 Cross-platform**: Works on Windows, macOS, and Linux operating systems.
-- **🔧 Compatibility**: Supports all Lean versions between `v4.7.0-rc1` and `v4.22.0-rc3`.
+- **🔧 Compatibility**: Supports all Lean versions between `v4.7.0-rc1` and `v4.22.0-rc4`.
   - We backport the latest features of Lean REPL to older versions of Lean (see [fork](https://github.com/augustepoiroux/repl)).
 - **📦 Temporary Projects**: Easily instantiate temporary Lean environments.
   - Useful for experimenting with benchmarks depending on [Mathlib](https://github.com/leanprover-community/mathlib4) like [ProofNet#](https://huggingface.co/datasets/PAug/ProofNetSharp) and [MiniF2F](https://github.com/yangky11/miniF2F-lean4).
@@ -81,7 +83,6 @@ Description-Content-Type: text/markdown
   - [Custom Lean REPL](#custom-lean-repl)
 - [Similar tools](#similar-tools)
 - [Troubleshooting](#troubleshooting)
-- [Contributing](#contributing)
 - [Citation](#citation)
 - [License](#license)
 
@@ -264,13 +265,17 @@ config = LeanREPLConfig(lean_version="v4.7.0")
 #### Existing Lean projects
 
 ```python
-config = LeanREPLConfig(project=LocalProject("path/to/your/project"))
+# Local project
+project = LocalProject(directory="path/to/your/project")
+config = LeanREPLConfig(project=project)
 ```
 
 or
 
 ```python
-config = LeanREPLConfig(project=GitProject("https://github.com/yangky11/lean4-example"))
+# Git project
+project = GitProject(url="https://github.com/yangky11/lean4-example", rev="main")
+config = LeanREPLConfig(project=project)
 ```
 
 You can then use `run` as usual:
@@ -288,19 +293,24 @@ server.run(FileCommand(path="file.lean"))
 #### Temporary project with dependencies
 
 ```python
-from lean_interact import TempRequireProject
-
-config = LeanREPLConfig(lean_version="v4.7.0", project=TempRequireProject([LeanRequire(
-    name="mathlib",
-    git="https://github.com/leanprover-community/mathlib4.git",
-    rev="v4.7.0"
-)]))
+from lean_interact import TempRequireProject, LeanRequire
+
+project = TempRequireProject(
+    lean_version="v4.8.0", 
+    require=[LeanRequire(
+        name="mathlib",
+        git="https://github.com/leanprover-community/mathlib4.git",
+        rev="v4.8.0"
+    )]
+)
+config = LeanREPLConfig(project=project)
 ```
 
 Mathlib being a frequent requirement, a shortcut is available:
 
 ```python
-config = LeanREPLConfig(lean_version="v4.7.0", project=TempRequireProject("mathlib"))
+project = TempRequireProject(lean_version="v4.8.0", require="mathlib")
+config = LeanREPLConfig(project=project)
 ```
 
 You can then use Mathlib as follows:
@@ -347,7 +357,9 @@ For more control over the temporary project, you can use `TemporaryProject` to s
 ```python
 from lean_interact import TemporaryProject
 
-config = LeanREPLConfig(lean_version="v4.18.0", project=TemporaryProject("""
+project = TemporaryProject(
+    lean_version="v4.18.0", 
+    content="""
 import Lake
 open Lake DSL
 
@@ -360,7 +372,9 @@ lean_exe "dummy" where
 
 require mathlib from git
   "https://github.com/leanprover-community/mathlib4.git" @ "v4.18.0"
-"""))
+"""
+)
+config = LeanREPLConfig(project=project)
 ```
 
 ## Available Queries
@@ -520,16 +534,6 @@ If you get an error similar to the following one, you are likely affected by thi
     git config --system core.longpaths true
     ```
 
-## Contributing
-
-Contributions are welcome! Here's how you can help:
-
-1. Fork the repository
-2. Create a feature branch: `git checkout -b feature-name`
-3. Commit your changes: `git commit -am 'Add new feature'`
-4. Push to the branch: `git push origin feature-name`
-5. Submit a pull request
-
 ## Citation
 
 If you use LeanInteract in your research, please cite it as follows:

{lean_interact-0.7.0 → lean_interact-0.8.0}/README.md

@@ -1,6 +1,6 @@
 # LeanInteract
 
-[![Docs](https://img.shields.io/badge/docs-latest-blue.svg)](https://augustepoiroux.github.io/LeanInteract/)
+[![Documentation](https://img.shields.io/badge/docs-latest-purple.svg)](https://augustepoiroux.github.io/LeanInteract/)
 [![PyPI version](https://img.shields.io/pypi/v/lean-interact.svg)](https://pypi.org/project/lean-interact/)
 [![PyPI downloads](https://img.shields.io/pepy/dt/lean-interact.svg)](https://pypi.org/project/lean-interact/)
 [![Python 3.10+](https://img.shields.io/badge/python-3.10+-blue.svg)](https://www.python.org/downloads/)
@@ -8,12 +8,14 @@
 
 **LeanInteract** is a Python package designed to seamlessly interact with Lean 4 through the [Lean REPL](https://github.com/leanprover-community/repl).
 
+Check the [documentation](https://augustepoiroux.github.io/LeanInteract/) for detailed usage and examples.
+
 ## Key Features
 
 - **🔗 Interactivity**: Execute Lean code and files directly from Python.
 - **🚀 Ease of Use**: LeanInteract abstracts the complexities of Lean setup and interaction.
 - **💻 Cross-platform**: Works on Windows, macOS, and Linux operating systems.
-- **🔧 Compatibility**: Supports all Lean versions between `v4.7.0-rc1` and `v4.22.0-rc3`.
+- **🔧 Compatibility**: Supports all Lean versions between `v4.7.0-rc1` and `v4.22.0-rc4`.
   - We backport the latest features of Lean REPL to older versions of Lean (see [fork](https://github.com/augustepoiroux/repl)).
 - **📦 Temporary Projects**: Easily instantiate temporary Lean environments.
   - Useful for experimenting with benchmarks depending on [Mathlib](https://github.com/leanprover-community/mathlib4) like [ProofNet#](https://huggingface.co/datasets/PAug/ProofNetSharp) and [MiniF2F](https://github.com/yangky11/miniF2F-lean4).
@@ -43,7 +45,6 @@
   - [Custom Lean REPL](#custom-lean-repl)
 - [Similar tools](#similar-tools)
 - [Troubleshooting](#troubleshooting)
-- [Contributing](#contributing)
 - [Citation](#citation)
 - [License](#license)
 
@@ -226,13 +227,17 @@ config = LeanREPLConfig(lean_version="v4.7.0")
 #### Existing Lean projects
 
 ```python
-config = LeanREPLConfig(project=LocalProject("path/to/your/project"))
+# Local project
+project = LocalProject(directory="path/to/your/project")
+config = LeanREPLConfig(project=project)
 ```
 
 or
 
 ```python
-config = LeanREPLConfig(project=GitProject("https://github.com/yangky11/lean4-example"))
+# Git project
+project = GitProject(url="https://github.com/yangky11/lean4-example", rev="main")
+config = LeanREPLConfig(project=project)
 ```
 
 You can then use `run` as usual:
@@ -250,19 +255,24 @@ server.run(FileCommand(path="file.lean"))
 #### Temporary project with dependencies
 
 ```python
-from lean_interact import TempRequireProject
-
-config = LeanREPLConfig(lean_version="v4.7.0", project=TempRequireProject([LeanRequire(
-    name="mathlib",
-    git="https://github.com/leanprover-community/mathlib4.git",
-    rev="v4.7.0"
-)]))
+from lean_interact import TempRequireProject, LeanRequire
+
+project = TempRequireProject(
+    lean_version="v4.8.0", 
+    require=[LeanRequire(
+        name="mathlib",
+        git="https://github.com/leanprover-community/mathlib4.git",
+        rev="v4.8.0"
+    )]
+)
+config = LeanREPLConfig(project=project)
 ```
 
 Mathlib being a frequent requirement, a shortcut is available:
 
 ```python
-config = LeanREPLConfig(lean_version="v4.7.0", project=TempRequireProject("mathlib"))
+project = TempRequireProject(lean_version="v4.8.0", require="mathlib")
+config = LeanREPLConfig(project=project)
 ```
 
 You can then use Mathlib as follows:
@@ -309,7 +319,9 @@ For more control over the temporary project, you can use `TemporaryProject` to s
 ```python
 from lean_interact import TemporaryProject
 
-config = LeanREPLConfig(lean_version="v4.18.0", project=TemporaryProject("""
+project = TemporaryProject(
+    lean_version="v4.18.0", 
+    content="""
 import Lake
 open Lake DSL
 
@@ -322,7 +334,9 @@ lean_exe "dummy" where
 
 require mathlib from git
   "https://github.com/leanprover-community/mathlib4.git" @ "v4.18.0"
-"""))
+"""
+)
+config = LeanREPLConfig(project=project)
 ```
 
 ## Available Queries
@@ -482,16 +496,6 @@ If you get an error similar to the following one, you are likely affected by thi
     git config --system core.longpaths true
     ```
 
-## Contributing
-
-Contributions are welcome! Here's how you can help:
-
-1. Fork the repository
-2. Create a feature branch: `git checkout -b feature-name`
-3. Commit your changes: `git commit -am 'Add new feature'`
-4. Push to the branch: `git push origin feature-name`
-5. Submit a pull request
-
 ## Citation
 
 If you use LeanInteract in your research, please cite it as follows:

lean_interact-0.8.0/docs/api/config.md

@@ -0,0 +1,7 @@
+::: lean_interact.config
+    options:
+      heading_level: 1
+      heading: "Configuration"
+      show_symbol_type_heading: false
+      members:
+        - LeanREPLConfig

lean_interact-0.8.0/docs/api/interface.md

@@ -0,0 +1,26 @@
+::: lean_interact.interface
+    options:
+      heading_level: 1
+      heading: "Interface"
+      show_symbol_type_heading: false
+      members:
+        - Command
+        - FileCommand
+        - ProofStep
+        - PickleEnvironment
+        - UnpickleEnvironment
+        - PickleProofState
+        - UnpickleProofState
+        - CommandResponse
+        - ProofStepResponse
+        - LeanError
+        - Message
+        - Pos
+        - Range
+        - Sorry
+        - Tactic
+        - InfoTree
+        - TacticNode
+        - CommandNode
+        - TermNode
+        - Syntax

lean_interact-0.8.0/docs/api/project.md

@@ -0,0 +1,11 @@
+::: lean_interact.project
+    options:
+      heading_level: 1
+      heading: "Projects"
+      show_symbol_type_heading: false
+      members:
+        - LocalProject
+        - GitProject
+        - TemporaryProject
+        - TempRequireProject
+        - LeanRequire

lean_interact-0.8.0/docs/api/server.md

@@ -0,0 +1,8 @@
+::: lean_interact.server
+    options:
+      heading_level: 1
+      heading: "Lean Servers"
+      show_symbol_type_heading: false
+      members:
+        - LeanServer
+        - AutoLeanServer

lean_interact-0.8.0/docs/api/sessioncache.md

@@ -0,0 +1,9 @@
+::: lean_interact.sessioncache
+    options:
+      heading_level: 1
+      heading: "Session Cache"
+      show_symbol_type_heading: false
+      members:
+        - PickleSessionCache
+        - SessionState
+        - PickleSessionState

lean_interact-0.8.0/docs/api/utils.md

@@ -0,0 +1,69 @@
+# Utilities
+
+This page documents the utility functions and classes used in LeanInteract.
+
+## Installation and Cache Management
+
+::: lean_interact.utils.install_lean
+    options:
+      heading_level: 3
+
+::: lean_interact.utils.clear_cache
+    options:
+      heading_level: 3
+
+## Project Utilities
+
+::: lean_interact.utils.get_project_lean_version
+    options:
+      heading_level: 3
+
+## Windows Path Utilities
+
+::: lean_interact.utils.check_windows_long_paths
+    options:
+      heading_level: 3
+
+## Memory Management
+
+::: lean_interact.utils.get_total_memory_usage
+    options:
+      heading_level: 3
+
+## Code Processing Utilities
+
+::: lean_interact.utils.indent_code
+    options:
+      heading_level: 3
+
+::: lean_interact.utils.compress_newlines
+    options:
+      heading_level: 3
+
+::: lean_interact.utils.lean_comments_ranges
+    options:
+      heading_level: 3
+
+::: lean_interact.utils.remove_lean_comments
+    options:
+      heading_level: 3
+
+::: lean_interact.utils.split_implementation
+    options:
+      heading_level: 3
+
+::: lean_interact.utils.split_conclusion
+    options:
+      heading_level: 3
+
+::: lean_interact.utils.clean_theorem_string
+    options:
+      heading_level: 3
+
+::: lean_interact.utils.extract_last_theorem
+    options:
+      heading_level: 3
+
+::: lean_interact.utils.clean_last_theorem_string
+    options:
+      heading_level: 3