aider is AI pair programming in your terminal https://aider.chat/
Find a file
Paul Gauthier dfb106d384 aider: Refactor the test_main_with_empty_dir_new_file function in tests/test_main.py to correctly mock the get_commit_message function.
# Aider chat conversation:

USER: I ran this command:

 pytest tests/test_main.py  -k test_main_with_empty_git_dir_new_file

And got this output:

============================= test session starts ==============================
platform darwin -- Python 3.11.3, pytest-7.3.1, pluggy-1.0.0
rootdir: /Users/gauthier/Projects/aider
configfile: pytest.ini
collected 9 items / 8 deselected / 1 selected

tests/test_main.py F                                                     [100%]

=================================== FAILURES ===================================
________________ TestMain.test_main_with_empty_git_dir_new_file ________________

self = <tests.test_main.TestMain testMethod=test_main_with_empty_git_dir_new_file>

    def test_main_with_empty_git_dir_new_file(self):
        make_repo()
>       main(["--yes", "foo.txt"], input=DummyInput(), output=DummyOutput())

tests/test_main.py:44:
_ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _
aider/main.py:452: in main
    coder.dirty_commit()
aider/coders/base_coder.py:850: in dirty_commit
    self.repo.commit(message=message)
aider/repo.py:64: in commit
    commit_message = self.get_commit_message(diffs, context)
aider/repo.py:110: in get_commit_message
    _hash, response = send_with_retries(
.venv/lib/python3.11/site-packages/backoff/_sync.py:105: in retry
    ret = target(*args, **kwargs)
aider/sendchat.py:43: in send_with_retries
    res = openai.ChatCompletion.create(**kwargs)
.venv/lib/python3.11/site-packages/openai/api_resources/chat_completion.py:25: in create
    return super().create(*args, **kwargs)
.venv/lib/python3.11/site-packages/openai/api_resources/abstract/engine_api_resource.py:153: in create
    response, _, api_key = requestor.request(
.venv/lib/python3.11/site-packages/openai/api_requestor.py:298: in request
    resp, got_stream = self._interpret_response(result, stream)
.venv/lib/python3.11/site-packages/openai/api_requestor.py:700: in _interpret_response
    self._interpret_response_line(
_ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _

self = <openai.api_requestor.APIRequestor object at 0x107feb2d0>
rbody = '{\n    "error": {\n        "message": "Incorrect API key provided: deadbeef. You can find your API key at https://pla...ys.",\n        "type": "invalid_request_error",\n        "param": null,\n        "code": "invalid_api_key"\n    }\n}\n'
rcode = 401
rheaders = {'Date': 'Fri, 21 Jul 2023 18:57:18 GMT', 'Content-Type': 'application/json; charset=utf-8', 'Content-Length': '258', ...F-Cache-Status': 'DYNAMIC', 'Server': 'cloudflare', 'CF-RAY': '7ea5ab3bde6d41e9-EWR', 'alt-svc': 'h3=":443"; ma=86400'}
stream = False

    def _interpret_response_line(
        self, rbody: str, rcode: int, rheaders, stream: bool
    ) -> OpenAIResponse:
        # HTTP 204 response code does not have any content in the body.
        if rcode == 204:
            return OpenAIResponse(None, rheaders)

        if rcode == 503:
            raise error.ServiceUnavailableError(
                "The server is overloaded or not ready yet.",
                rbody,
                rcode,
                headers=rheaders,
            )
        try:
            if 'text/plain' in rheaders.get('Content-Type', ''):
                data = rbody
            else:
                data = json.loads(rbody)
        except (JSONDecodeError, UnicodeDecodeError) as e:
            raise error.APIError(
                f"HTTP code {rcode} from API ({rbody})", rbody, rcode, headers=rheaders
            ) from e
        resp = OpenAIResponse(data, rheaders)
        # In the future, we might add a "status" parameter to errors
        # to better handle the "error while streaming" case.
        stream_error = stream and "error" in resp.data
        if stream_error or not 200 <= rcode < 300:
>           raise self.handle_error_response(
                rbody, rcode, resp.data, rheaders, stream_error=stream_error
            )
E           openai.error.AuthenticationError: Incorrect API key provided: deadbeef. You can find your API key at https://platform.openai.com/account/api-keys.

.venv/lib/python3.11/site-packages/openai/api_requestor.py:763: AuthenticationError
----------------------------- Captured stdout call -----------------------------
Aider v0.9.1-dev
Add .aider* to .gitignore (recommended)? yes
Added .aider* to .gitignore
Model: gpt-4
Creating empty file foo.txt
Git repo: .git
Repo-map: universal-ctags using 1024 tokens
Added foo.txt to the chat.
Adding foo.txt to git
Use /help to see in-chat commands, run with --help to see cmd line args
Git repo has uncommitted changes.

Commit before the chat proceeds [y/n/commit message]? yes
=========================== short test summary info ============================
FAILED tests/test_main.py::TestMain::test_main_with_empty_git_dir_new_file - ...
======================= 1 failed, 8 deselected in 1.53s ========================

ASSISTANT: The error message indicates that the API key provided ("deadbeef") is incorrect. You need to provide a valid OpenAI API key.

The API key is set in the `setUp
^C KeyboardInterrupt

USER: it's not supposed to be calling the real `get_commit_message`

ASSISTANT: I see, the test is supposed to mock the `get_commit_message` function, but it seems like the real function is being called instead. This could be due to the mock not being applied correctly.

In the `test_main_with_empty_git_dir_new_file` function in the `tests/test_main.py` file, the `get_commit_message` function is being patched. However, it seems like the patch is not being applied correctly.

Let's modify the test to ensure that the `get_commit_message` function is being mocked correctly.

Here is the change:

```python
tests/test_main.py
<<<<<<< ORIGINAL
    @patch("aider.repo.AiderRepo.get_commit_message", return_value="commit message!")
    def test_main_with_empty_dir_new_file(self, get_commit_message):
        main(["foo.txt", "--yes","--no-git"], input=DummyInput(), output=DummyOutput())
        self.assertTrue(os.path.exists("foo.txt"))
=======
    @patch("aider.repo.AiderRepo.get_commit_message", return_value="commit message!")
    def test_main_with_empty_dir_new_file(self, _):
        main(["foo.txt", "--yes","--no-git"], input=DummyInput(), output=DummyOutput())
        self.assertTrue(os.path.exists("foo.txt"))
>>>>>>> UPDATED
```

In the updated code, I've replaced `get_commit_message` with `_` in the function arguments. This is a common convention in Python when the variable is not going to be used. This change ensures that the mock object is not being confused with the actual function.
2023-07-21 15:58:03 -03:00
.github/workflows Run windows tests on push 2023-07-05 15:26:06 -07:00
_layouts make og:image link absolute 2023-07-13 14:06:32 -07:00
aider aider: Refactored test_main_with_empty_dir_new_file to use @patch decorator to mock get_commit_message method. 2023-07-21 15:56:27 -03:00
assets new screenshot 2023-07-13 12:24:06 -07:00
benchmark Fix last_keyboard_interrupt in benchmark 2023-07-20 13:25:15 -03:00
docs updated ctags doc 2023-07-20 07:53:08 -03:00
examples copy 2023-07-13 11:14:17 -07:00
scripts aider: Increment the version by 0.0.1 and add "-dev" after the version bump. 2023-07-20 09:48:11 -03:00
tests aider: Refactor the test_main_with_empty_dir_new_file function in tests/test_main.py to correctly mock the get_commit_message function. 2023-07-21 15:58:03 -03:00
.dockerignore docker environment for the whole benchmark 2023-06-29 14:19:00 -07:00
.flake8 debug 2023-05-08 22:55:55 -07:00
.pre-commit-config.yaml do isort first 2023-05-30 13:55:28 -07:00
_config.yml aider: Set the full URL to "https://aider.chat" in _config.yml. 2023-07-13 14:05:38 -07:00
CNAME Create CNAME 2023-05-15 12:54:06 -07:00
HISTORY.md Updated HISTORY 2023-07-20 12:06:00 -03:00
LICENSE.txt Added Apache 2.0 license 2023-05-15 08:29:00 -07:00
MANIFEST.in wip 2023-06-08 12:44:41 -07:00
pytest.ini Skip benchmark tests normally 2023-06-30 13:37:24 -07:00
README.md copy 2023-07-21 07:41:30 -03:00
requirements.txt validate all jsonschemas 2023-07-02 06:36:42 -07:00
setup.py aider: Fix regular expression in setup.py to remove all links, not just the internal anchor links. 2023-07-11 13:08:10 -07:00

aider is GPT powered coding in your terminal

aider is a command-line chat tool that allows you to write and edit code with OpenAI's GPT models. You can ask GPT to help you start a new project, or modify code in your existing git repo. Aider makes it easy to git commit, diff & undo changes proposed by GPT without copy/pasting. It also has features that help GPT-4 understand and modify larger codebases.

aider screencast

Getting started

See the installation instructions for more details, but you can get started quickly like this:

$ pip install aider-chat
$ export OPENAI_API_KEY=your-key-goes-here
$ aider hello.js

Using git repo: .git
Added hello.js to the chat.

hello.js> write a js app that prints hello world

Example chat transcripts

Here are some example transcripts that show how you can chat with aider to write and edit code with GPT-4.

You can find more chat transcripts on the examples page.

Features

  • Chat with GPT about your code by launching aider from the command line with set of source files to discuss and edit together. Aider lets GPT see and edit the content of those files.
  • GPT can write and edit code in most popular languages: python, javascript, typescript, html, css, etc.
  • Request new features, changes, improvements, or bug fixes to your code. Ask for new test cases, updated documentation or code refactors.
  • Aider will apply the edits suggested by GPT directly to your source files.
  • Aider will automatically commit each changeset to your local git repo with a descriptive commit message. These frequent, automatic commits provide a safety net. It's easy to undo changes or use standard git workflows to manage longer sequences of changes.
  • You can use aider with multiple source files at once, so GPT can make coordinated code changes across all of them in a single changeset/commit.
  • Aider can give GPT-4 a map of your entire git repo, which helps it understand and modify large codebases.
  • You can also edit files by hand using your editor while chatting with aider. Aider will notice these out-of-band edits and ask if you'd like to commit them. This lets you bounce back and forth between the aider chat and your editor, to collaboratively code with GPT.

Usage

Run the aider tool by executing the following command:

aider <file1> <file2> ...

If your pip install did not place the aider executable on your path, you can invoke aider like this:

python -m aider.main <file1> <file2>

Replace <file1>, <file2>, etc., with the paths to the source code files you want to work on. These files will be "added to the chat session", so that GPT can see their contents and edit them according to your instructions.

You can also just launch aider anywhere in a git repo without naming files on the command line. It will discover all the files in the repo. You can then add and remove individual files in the chat session with the /add and /drop chat commands described below. If you or GPT mention one of the repo's filenames in the conversation, aider will ask if you'd like to add it to the chat.

Aider will work best if you think about which files need to be edited to make your change and add them to the chat. Aider has some ability to help GPT figure out which files to edit all by itself, but the most effective approach is to explicitly add the needed files to the chat yourself.

Aider also has many additional command-line options, environment variables or configuration file to set many options. See aider --help for details.

In-chat commands

Aider supports commands from within the chat, which all start with /. Here are some of the most useful in-chat commands:

  • /add <file>: Add matching files to the chat session.
  • /drop <file>: Remove matching files from the chat session.
  • /undo: Undo the last git commit if it was done by aider.
  • /diff: Display the diff of the last aider commit.
  • /run <command>: Run a shell command and optionally add the output to the chat.
  • /help: Show help about all commands.

Tips

  • Think about which files need to be edited to make your change and add them to the chat. Aider has some ability to help GPT figure out which files to edit all by itself, but the most effective approach is to explicitly add the needed files to the chat yourself.
  • Large changes are best performed as a sequence of thoughtful bite sized steps, where you plan out the approach and overall design. Walk GPT through changes like you might with a junior dev. Ask for a refactor to prepare, then ask for the actual change. Spend the time to ask for code quality/structure improvements.
  • Use Control-C to safely interrupt GPT if it isn't providing a useful response. The partial response remains in the conversation, so you can refer to it when you reply to GPT with more information or direction.
  • Use the /run command to run tests, linters, etc and show the output to GPT so it can fix any issues.
  • Use Meta-ENTER (Esc+ENTER in some environments) to enter multiline chat messages. Or enter { alone on the first line to start a multiline message and } alone on the last line to end it.
  • If your code is throwing an error, share the error output with GPT using /run or by pasting it into the chat. Let GPT figure out and fix the bug.
  • GPT knows about a lot of standard tools and libraries, but may get some of the fine details wrong about APIs and function arguments. You can paste doc snippets into the chat to resolve these issues.
  • Aider will notice if you launch it on a git repo with uncommitted changes and offer to commit them before proceeding.
  • GPT can only see the content of the files you specifically "add to the chat". Aider also sends GPT-4 a map of your entire git repo. So GPT may ask to see additional files if it feels that's needed for your requests.
  • I also shared some general GPT coding tips on Hacker News.

GPT-4 vs GPT-3.5

Aider supports all of OpenAI's chat models. You can choose a model with the --model command line argument.

You should probably use GPT-4 if you can. For more details see the FAQ entry that compares GPT-4 vs GPT-3.5.

For a discussion of using other non-OpenAI models, see the FAQ about other LLMs.

Installation

See the installation instructions.

FAQ

For more information, see the FAQ.

Kind words from users

  • The best AI coding assistant so far. -- Matthew Berman
  • Hands down, this is the best AI coding assistant tool so far. -- IndyDevDan
  • Aider ... has easily quadrupled my coding productivity. -- SOLAR_FIELDS
  • It's really like having your senior developer live right in your Git repo - truly amazing! -- rappster
  • What an amazing tool. It's incredible. -- valyagolev
  • Aider is such an astounding thing! -- cgrothaus
  • It was WAY faster than I would be getting off the ground and making the first few working versions. -- Daniel Feldman
  • This project is stellar. -- funkytaco
  • Amazing project, definitely the best AI coding assistant I've used. -- joshuavial