How to enable Python auto-completion in Vim

Vim can be configured to provide auto-completion for Python by using its built-in omnifunc feature. While Vim doesn’t have Python auto-completion out of the box, enabling omnifunc allows for context-aware completion of Python functions, methods, and variables without the need for additional plugins.

When omnifunc is set up for Python, it offers suggestions for Python built-in functions and variables, making the coding process more efficient and reducing the need to type out long method names. This keeps the development environment lightweight while improving workflow for Python programming within Vim.

By configuring omnifunc for Python, you can activate code completion specific to Python syntax and objects, streamlining your coding experience without adding unnecessary complexity. Follow these steps to enable omnifunc for Python auto-completion in Vim.

Step-by-step video guide:

Steps to configure Python auto-completion in Vim:

  1. Open any Python file in Vim.

    Use any existing or newly created `.py` file in Vim to test the completion feature before changing your configuration permanently.

  2. Manually set omnifunc to the Python completion function. 
    :set omnifunc=pythoncomplete#Complete
  3. Enter insert mode.

    Press the `i` key to enter insert mode in Vim.

  4. Trigger omnifunc completion with <C-x><C-o>.
  5. Review and select the suggested completions.

    Navigate using the arrow keys. Press `Enter` to select a suggestion or continue typing to refine the list.

  6. If the completion works, open your vimrc configuration file. 
    vim ~/.vimrc
  7. Add a new autocmd to enable omnifunc for Python files. 
    autocmd FileType python setlocal omnifunc=pythoncomplete#Complete
  8. Save and close the vimrc file.

    Save your changes by using `:wq` in Vim.

  9. Reopen any Python file to verify the changes.

    Once reopened, omnifunc will automatically trigger for files with the `.py` extension.

  10. (Optional) Create a key mapping to simplify triggering omnifunc completion. 
    inoremap <silent><expr> <Tab> pumvisible() ? "\<C-n>" : "\<C-x>\<C-o>"

    This mapping allows you to use `<Tab>` to trigger omnifunc and cycle through the completion suggestions.