patchllm 0.2.1__py3-none-any.whl → 1.0.0__py3-none-any.whl

patchllm/utils.py

@@ -1,5 +1,9 @@
 import importlib.util
 from pathlib import Path
+import pprint
+from rich.console import Console
+
+console = Console()
 
 def load_from_py_file(file_path, dict_name):
     """Dynamically loads a dictionary from a Python file."""
@@ -8,6 +12,8 @@ def load_from_py_file(file_path, dict_name):
         raise FileNotFoundError(f"The file '{path}' was not found.")
     
     spec = importlib.util.spec_from_file_location(path.stem, path)
+    if spec is None:
+         raise ImportError(f"Could not load spec for module at '{path}'")
     module = importlib.util.module_from_spec(spec)
     spec.loader.exec_module(module)
 
@@ -15,4 +21,16 @@ def load_from_py_file(file_path, dict_name):
     if not isinstance(dictionary, dict):
         raise TypeError(f"The file '{path}' must contain a dictionary named '{dict_name}'.")
     
-    return dictionary
+    return dictionary
+
+def write_scopes_to_file(file_path, scopes_dict):
+    """Writes the scopes dictionary back to a Python file."""
+    try:
+        path = Path(file_path)
+        with open(path, "w", encoding="utf-8") as f:
+            f.write("scopes = ")
+            f.write(pprint.pformat(scopes_dict, indent=4))
+            f.write("\n")
+        console.print(f"✅ Successfully updated '{path}'.", style="green")
+    except Exception as e:
+        console.print(f"❌ Failed to write to '{path}': {e}", style="red")

patchllm/{listener.py → voice/listener.py}

@@ -17,6 +17,7 @@ def listen(prompt=None, timeout=5):
             speak(prompt)
         console.print("🎙 Listening...", style="cyan")
         try:
+            recognizer.adjust_for_ambient_noise(source)
             audio = recognizer.listen(source, timeout=timeout)
             text = recognizer.recognize_google(audio)
             console.print(f"🗣 Recognized: {text}", style="cyan")
@@ -27,4 +28,10 @@ def listen(prompt=None, timeout=5):
             speak("Sorry, I didn’t catch that.")
         except sr.RequestError:
             speak("Speech recognition failed. Check your internet.")
-    return None
+    return None
+```<file_path:patchllm/__main__.py>
+```python
+from .cli.entrypoint import main
+
+if __name__ == "__main__":
+    main()

patchllm-1.0.0.dist-info/METADATA

@@ -0,0 +1,153 @@
+Metadata-Version: 2.4
+Name: patchllm
+Version: 1.0.0
+Summary: An interactive agent for codebase modification using LLMs
+Author: nassimberrada
+License: MIT License
+        
+        Copyright (c) 2025 nassimberrada
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the “Software”), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all
+        copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+        SOFTWARE.
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: litellm
+Requires-Dist: python-dotenv
+Requires-Dist: rich
+Requires-Dist: prompt_toolkit
+Requires-Dist: InquirerPy
+Provides-Extra: voice
+Requires-Dist: SpeechRecognition; extra == "voice"
+Requires-Dist: pyttsx3; extra == "voice"
+Provides-Extra: url
+Requires-Dist: html2text; extra == "url"
+Provides-Extra: all
+Requires-Dist: SpeechRecognition; extra == "all"
+Requires-Dist: pyttsx3; extra == "all"
+Requires-Dist: html2text; extra == "all"
+Dynamic: license-file
+
+<p align="center">
+  <picture>
+    <source srcset="./assets/logo_dark.png" media="(prefers-color-scheme: dark)">
+    <source srcset="./assets/logo_light.png" media="(prefers-color-scheme: light)">
+    <img src="./assets/logo_light.png" alt="PatchLLM Logo" height="200">
+  </picture>
+</p>
+
+## About
+PatchLLM is an interactive command-line agent that helps you modify your codebase. It uses an LLM to plan and execute changes, allowing you to review and approve every step.
+
+## Key Features
+- **Interactive Planning:** The agent proposes a step-by-step plan before writing any code. You stay in control.
+- **Dynamic Context:** Build and modify the code context on-the-fly using powerful scope definitions (`@git:staged`, `@dir:src`, etc.).
+- **Mobile-First TUI:** A clean, command-driven interface with autocompletion makes it easy to use on any device.
+- **Resilient Sessions:** Automatically saves your progress so you can resume if you get disconnected.
+
+## Getting Started
+
+**1. Initialize a configuration file (optional):**
+This creates a `scopes.py` file to define reusable file collections.
+```bash
+patchllm --init
+```
+
+**2. Start the Agent:**
+Running `patchllm` with no arguments drops you into the interactive agentic TUI.
+```bash
+patchllm
+```
+
+**3. Follow the Agent Workflow:**
+Inside the TUI, you direct the agent with simple slash commands.
+
+```bash
+# 1. Set the goal
+>>> /task Add a health check endpoint to the API
+
+# 2. Build the context
+>>> /context @dir:src/api
+
+# 3. Ask the agent to generate a plan
+>>> /plan
+1. Add a new route `/health` to `src/api/routes.py`.
+2. Implement the health check logic to return a 200 OK status.
+
+# 4. Execute the first step and review the proposed changes
+>>> /run
+
+# 5. If the changes look good, approve them
+>>> /approve
+```
+
+## Agent Commands (TUI)
+| Command | Description |
+|---|---|
+| `/task <goal>` | Sets the high-level goal for the agent. |
+| `/plan [management]` | Generates a plan, or opens an interactive TUI to edit/add/remove steps. |
+| `/run [all]` | Executes the next step, or all remaining steps with `/run all`. |
+| `/approve` | Interactively select and apply changes from the last run. |
+| `/diff [all \| file]`| Shows the full diff for the proposed changes. |
+| `/retry <feedback>`| Retries the last step with new feedback. |
+| `/skip` | Skips the current step and moves to the next. |
+| `/revert` | Reverts the changes from the last `/approve`. |
+| `/context <scope>` | Replaces the context with files from a scope. |
+| `/scopes` | Opens an interactive menu to manage your saved scopes. |
+| `/ask <question>` | Ask a question about the plan or code context. |
+| `/refine <feedback>`| Refine the plan based on new feedback or ideas. |
+| `/show [state]` | Shows the current state (goal, plan, context, history, step). |
+| `/settings` | Configure the model and API keys. |
+| `/help` | Shows the detailed help message. |
+| `/exit` | Exits the agent session. |
+
+## Headless Mode Flags
+For scripting or single-shot edits, you can still use the original flags.
+
+| Flag | Alias | Description |
+|---|---|---|
+| `-p`, `--patch` | **Main action:** Query the LLM and apply file changes. |
+| `-t`, `--task` | Provide a specific instruction to the LLM. |
+| `-s`, `--scope` | Use a static scope from `scopes.py` or a dynamic one. |
+| `-r`, `--recipe` | Use a predefined task from `recipes.py`. |
+| `-in`, `--interactive` | Interactively build the context by selecting files. |
+| `-i`, `--init` | Create a new `scopes.py` file. |
+| `-sl`, `--list-scopes`| List all available scopes. |
+| `-ff`, `--from-file` | Apply patches from a local file. |
+| `-fc`, `--from-clipboard` | Apply patches from the system clipboard. |
+| `-m`, `--model` | Specify a different model (default: `gemini/gemini-1.5-flash`). |
+| `-v`, `--voice` | Enable voice interaction (requires voice dependencies). |
+
+## Setup
+PatchLLM uses [LiteLLM](https://github.com/BerriAI/litellm). Set up your API keys (e.g., `OPENAI_API_KEY`, `GEMINI_API_KEY`) in a `.env` file.
+
+The interactive TUI requires `prompt_toolkit` and `InquirerPy`. You can install all core dependencies with:```bash
+pip install -r requirements.txt
+```
+
+Optional features require extra dependencies:
+```bash
+# For URL support in scopes
+pip install "patchllm[url]"
+
+# For voice commands (in headless mode)
+pip install "patchllm[voice]"
+```
+
+## License
+This project is licensed under the MIT License.

patchllm-1.0.0.dist-info/RECORD

@@ -0,0 +1,51 @@
+patchllm/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+patchllm/__main__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+patchllm/llm.py,sha256=vy9PZ1tyG5nd1sH3R0jYQRUxSHgvmk9sV_zX6nw3Kfk,1475
+patchllm/main.py,sha256=suL4MmpshaVzkZ-ubhIE4GsVb0fKgyzU4GoHHaJbw88,71
+patchllm/parser.py,sha256=H6mjUehPK9WfM-zVIU5pAx5scNfra64Ld6TL9QN-2to,5340
+patchllm/patcher.py,sha256=zQ8nnhCXPvIeR9bMEj81lyeDvJyZp_Cenaux80aCivw,5024
+patchllm/utils.py,sha256=yjXElAanhB_l3Kn_PIiU6uheNrrVtH-2mM7N19CvjJE,1313
+patchllm/agent/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+patchllm/agent/actions.py,sha256=0IbhKmZ5TzYdeEB9NpC3IT-J4sXV6YTo-wMl9ws_Hgo,2428
+patchllm/agent/executor.py,sha256=pm4Elzzxy-ZGGktn7CKyv9cm8sOxCslxYXo3UGxEXUI,2114
+patchllm/agent/planner.py,sha256=LugSnVVBq7ZX0ji3ca-nfABle-4pY7W6C_fBwWFVN4A,3493
+patchllm/agent/session.py,sha256=M-4MzZMRrn26qug3iwXrAOTrFlHiOVO5OkyuX7Aj_Vc,18072
+patchllm/cli/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+patchllm/cli/entrypoint.py,sha256=nHpE_cJu1U3fHTkFdUdgb_FYGMor9573IcdUy8J0adA,5568
+patchllm/cli/handlers.py,sha256=uNVyJF-WzABNicEvAqeG_GduRLUXFfCGjBcZGrvdwpk,7854
+patchllm/cli/helpers.py,sha256=KYiYeTQTJMcxKa_jXiDM3lJrHxOQCt3Niohk1lb_osg,3556
+patchllm/interactive/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+patchllm/interactive/selector.py,sha256=aUfV5vpsWxkKpTl2JcmI4Zxcu6Zj4w4whJJhKV_MazM,3915
+patchllm/scopes/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+patchllm/scopes/builder.py,sha256=u1AF0DG0i6Lh0ZefmAPqlo3G8GIqNQkq2Xxug82Awl8,2294
+patchllm/scopes/constants.py,sha256=xogjoPXwkuLGONFtO3wIfiUBBb4sOAysa0VLAnGAapM,1950
+patchllm/scopes/helpers.py,sha256=5h6h1F-B1EP2m-PupDQP4V8lkUNLUSInV-IT_lqP1Rs,5897
+patchllm/scopes/resolvers.py,sha256=PxwRu_4GS8PMVIrQKtxWwWKx685XoEcRIikhkOmWI1o,3684
+patchllm/scopes/structure.py,sha256=KSxVpHxG0IlEwxx-kfZy5G1q_OiVRrPX-fMn7so2R5g,2688
+patchllm/tui/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+patchllm/tui/completer.py,sha256=Zb7fVXKZHcl_mZbIsmxJVgg3-JmuwXqTQz3E18obw5U,8555
+patchllm/tui/interface.py,sha256=yq5u7aeuEuRwtFQUlARMn1N5H5cLVMAC7u989jrUYUI,40547
+patchllm/voice/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+patchllm/voice/listener.py,sha256=t8noDPsKfYFnqPw9LkbQAIUejO4zq3J-p6ah_jkburU,1142
+patchllm-1.0.0.dist-info/licenses/LICENSE,sha256=vZxgIRNxffjkTV2NWLemgYjDRu0hSMTyFXCZ1zEWbUc,1077
+tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+tests/conftest.py,sha256=mJQG1axjsv97UNYcI3bfXMBk6xBiMDsW1aRkRBUqSUw,4093
+tests/test_actions.py,sha256=X67hUUC2bdSoI4XP8ImIjjxLoZC5AToPHAHZRKPdglY,1840
+tests/test_agent.py,sha256=aeAQ37GDZlJEKTXtDpZ03oF8NAMuG6oNN6-XESYorNs,15961
+tests/test_completer.py,sha256=6S1s3DAfQrBsPxIT4wjLfCIwSf84-ipB1-DxZuRqIW8,5866
+tests/test_context.py,sha256=wud1kEAGElefrtn2HWJ01MTuWLUk_TudLV9KCxJ44uM,4942
+tests/test_executor.py,sha256=IZ80oAaDrhi5daJjNIKOAc5pIUnTMFyKYsyLVBxDKmk,2344
+tests/test_interactive.py,sha256=W98JY7jRWN8-bCSZ1OE373FttGzOY4kVFd9m6f56nzc,2505
+tests/test_parser.py,sha256=mRS6BsnrPCUkZnHpNpMn71QbVZfJ25L1zTIMtoRJKrw,2848
+tests/test_patcher.py,sha256=xU-ATCI_w3H7_Jfri4qFyLNPTqBHT2pJ7Z0ZpyynJS0,2424
+tests/test_planner.py,sha256=zzurBD72WiO0Lz8YVCwVgPkEAhua56lWFZCu7Q-8eB0,2204
+tests/test_recipes.py,sha256=IFNW58xC1E3dT-Bxh1LS9eSKmkRZoNwX6y6cmVdSmDM,3850
+tests/test_scopes.py,sha256=WsVG4N7XU06LYgn0OIEGYs0QyPnMS-mS3LuarYjxxc8,2108
+tests/test_structure.py,sha256=Usoj7MP7V0skt2rONfaEVL4Q_nBM5cN3nlfRS1ax11U,2026
+tests/test_tui.py,sha256=o9sbSYaVK1kf8RLhWOhGFXF8h2gZ2HgIP4R7M3y_W0A,16123
+tests/test_utils.py,sha256=d8s5z2RXCbm3Tz29dCTm4tUqqx5U2W5ibOsjBN7f9s8,1142
+patchllm-1.0.0.dist-info/METADATA,sha256=EnylLS0H7Ztr263qpKxbdlWYXWazOn3y5y1lVXfg9kE,6332
+patchllm-1.0.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+patchllm-1.0.0.dist-info/entry_points.txt,sha256=6vKL9W8Lbel2FUys_L4b87FVtuLn8VkoDzC6ZyXgIIw,58
+patchllm-1.0.0.dist-info/top_level.txt,sha256=efpee4d-m4g0gCUGizjwsbGfqoFQE_nJytm8eTW3DYk,15
+patchllm-1.0.0.dist-info/RECORD,,

patchllm-1.0.0.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+patchllm = patchllm.cli.entrypoint:main

{patchllm-0.2.1.dist-info → patchllm-1.0.0.dist-info}/top_level.txt

@@ -1 +1,2 @@
 patchllm
+tests

tests/conftest.py

@@ -0,0 +1,112 @@
+import pytest
+import subprocess
+import textwrap
+from pathlib import Path
+
+@pytest.fixture
+def temp_project(tmp_path):
+    """Creates a temporary project structure for testing."""
+    project_dir = tmp_path / "test_project"
+    project_dir.mkdir()
+
+    (project_dir / "main.py").write_text("import utils\n\ndef hello():\n    print('hello')")
+    (project_dir / "utils.py").write_text("def helper_function():\n    return 1")
+    (project_dir / "README.md").write_text("# Test Project")
+
+    src_dir = project_dir / "src"
+    src_dir.mkdir()
+    (src_dir / "component.js").write_text("console.log('component');")
+    (src_dir / "styles.css").write_text("body { color: red; }")
+
+    tests_dir = project_dir / "tests"
+    tests_dir.mkdir()
+    (tests_dir / "test_utils.py").write_text("from .. import utils\n\ndef test_helper():\n    assert utils.helper_function() == 1")
+    
+    (project_dir / "data.log").write_text("some log data")
+    (project_dir / "logo.png").write_bytes(b'\x89PNG\r\n\x1a\n\x00\x00\x00\rIHDR\x00\x00\x00\x01\x00\x00\x00\x01\x08\x06\x00\x00\x00\x1f\x15\xc4\x89\x00\x00\x00\nIDATx\x9cc`\x00\x00\x00\x02\x00\x01\xe2!\xbc\x33\x00\x00\x00\x00IEND\xaeB`\x82')
+
+    return project_dir
+
+@pytest.fixture
+def git_project(temp_project):
+    """Initializes the temp_project as a Git repository."""
+    subprocess.run(["git", "init"], cwd=temp_project, check=True, capture_output=True)
+    subprocess.run(["git", "config", "user.name", "Test User"], cwd=temp_project, check=True)
+    subprocess.run(["git", "config", "user.email", "test@example.com"], cwd=temp_project, check=True)
+    subprocess.run(["git", "add", "."], cwd=temp_project, check=True)
+    subprocess.run(["git", "commit", "-m", "Initial commit"], cwd=temp_project, check=True, capture_output=True)
+    return temp_project
+
+@pytest.fixture
+def temp_scopes_file(tmp_path):
+    """Creates a temporary scopes.py file for testing."""
+    scopes_content = """
+scopes = {
+    'base': {
+        'path': '.',
+        'include_patterns': ['**/*.py'],
+        'exclude_patterns': ['tests/**'],
+    },
+    'search_scope': {
+        'path': '.',
+        'include_patterns': ['**/*'],
+        'search_words': ['hello']
+    },
+    'js_and_css': {
+        'path': 'src',
+        'include_patterns': ['**/*.js', '**/*.css']
+    }
+}
+"""
+    scopes_file = tmp_path / "scopes.py"
+    scopes_file.write_text(scopes_content)
+    return scopes_file
+
+@pytest.fixture
+def temp_recipes_file(tmp_path):
+    """Creates a temporary recipes.py file for testing."""
+    recipes_content = """
+recipes = {
+    "add_tests": "Please write comprehensive pytest unit tests for the functions in the provided file.",
+    "add_docs": "Generate Google-style docstrings for all public functions and classes.",
+}
+"""
+    recipes_file = tmp_path / "recipes.py"
+    recipes_file.write_text(recipes_content)
+    return recipes_file
+
+@pytest.fixture
+def mixed_project(tmp_path):
+    """Creates a project with both Python and JS files for structure testing."""
+    proj_dir = tmp_path / "mixed_project"
+    
+    py_api_dir = proj_dir / "api"
+    py_api_dir.mkdir(parents=True)
+    (py_api_dir / "main.py").write_text(textwrap.dedent("""
+        import os
+        from .models import User
+        class APIServer:
+            def start(self): pass
+        async def get_user(id: int) -> User:
+            # A comment
+            return User()
+        """))
+    (py_api_dir / "models.py").write_text(textwrap.dedent("""
+        from db import Base
+        class User(Base): pass
+        """))
+
+    js_src_dir = proj_dir / "frontend" / "src"
+    js_src_dir.mkdir(parents=True)
+    (js_src_dir / "index.js").write_text(textwrap.dedent("""
+        import React from "react";
+        export class App extends React.Component { render() { return <h1>Hello</h1>; } }
+        export const arrowFunc = () => { console.log('test'); }
+        """))
+    (js_src_dir / "utils.ts").write_text(textwrap.dedent("""
+        export async function fetchData(url: string): Promise<any> { }
+        """))
+    
+    (proj_dir / "README.md").write_text("# Mixed Project")
+
+    return proj_dir

tests/test_actions.py

@@ -0,0 +1,62 @@
+import pytest
+from unittest.mock import patch, MagicMock
+from patchllm.agent.actions import run_tests, stage_files
+
+@patch('subprocess.run')
+def test_run_tests_passed(mock_subprocess_run):
+    """
+    Tests the run_tests function when pytest returns a success code.
+    """
+    mock_result = MagicMock()
+    mock_result.returncode = 0
+    mock_result.stdout = "== 1 passed in 0.1s =="
+    mock_result.stderr = ""
+    mock_subprocess_run.return_value = mock_result
+    
+    run_tests()
+    
+    mock_subprocess_run.assert_called_once_with(
+        ["pytest"], capture_output=True, text=True, check=False
+    )
+
+@patch('subprocess.run')
+def test_run_tests_failed(mock_subprocess_run):
+    """
+    Tests the run_tests function when pytest returns a failure code.
+    """
+    mock_result = MagicMock()
+    mock_result.returncode = 1
+    mock_result.stdout = "== 1 failed in 0.2s =="
+    mock_result.stderr = ""
+    mock_subprocess_run.return_value = mock_result
+    
+    run_tests()
+    
+    mock_subprocess_run.assert_called_once()
+
+@patch('subprocess.run')
+def test_stage_files_all(mock_subprocess_run):
+    """
+    Tests staging all files with `git add .`.
+    """
+    mock_subprocess_run.return_value = MagicMock(returncode=0, stdout="", stderr="")
+    
+    stage_files()
+    
+    mock_subprocess_run.assert_called_once_with(
+        ["git", "add", "."], capture_output=True, text=True, check=True
+    )
+
+@patch('subprocess.run')
+def test_stage_files_specific(mock_subprocess_run):
+    """
+    Tests staging a specific list of files.
+    """
+    mock_subprocess_run.return_value = MagicMock(returncode=0, stdout="", stderr="")
+    files = ["main.py", "utils.py"]
+    
+    stage_files(files)
+    
+    mock_subprocess_run.assert_called_once_with(
+        ["git", "add", "main.py", "utils.py"], capture_output=True, text=True, check=True
+    )