mirror of
https://github.com/neovim/neovim.git
synced 2025-11-11 13:05:37 +00:00
23a3e58f02
Tighten our jargon, avoid mentioning "msgpack" everywhere we mention the RPC API. Prefer "RPC API" when speaking about the remote API. Though it's conceivable that we may one day support some protocol other than msgpack, that isn't relevant to most of our discussion of the API, including this document. The file name msgpack_rpc.txt is preserved to avoid totally breaking URLs.
113 lines
3.8 KiB
Plaintext
113 lines
3.8 KiB
Plaintext
*nvim_python.txt* For Nvim. {Nvim}
|
|
|
|
|
|
NVIM REFERENCE MANUAL by Thiago de Arruda
|
|
|
|
|
|
Python plugins and scripting in Nvim *nvim-python*
|
|
|
|
1. Introduction |nvim-python-intro|
|
|
2. Quickstart |nvim-python-quickstart|
|
|
3. Troubleshooting |nvim-python-troubleshooting|
|
|
|
|
==============================================================================
|
|
1. Introduction *nvim-python-intro*
|
|
|
|
Through external Python interpreters connected via |rpc|, Nvim supports the
|
|
legacy |python-vim| and |python3| interfaces.
|
|
|
|
Note: Only the Vim 7.3 API is supported; bindeval (Vim 7.4) is not.
|
|
|
|
==============================================================================
|
|
2. Quickstart *nvim-python-quickstart*
|
|
|
|
If you used a package manager to install Nvim, there's a good chance that
|
|
it also provides the `neovim` Python package. If it doesn't, follow these
|
|
steps to install the package with Python's package manager, `pip`.
|
|
|
|
Note: Depending on your system, `pip` might refer to Python 2 or Python 3,
|
|
which is why the following instructions mention `pip2` or `pip3`
|
|
explicitly. If one of these is not available for you, maybe `pip`
|
|
is what you want.
|
|
|
|
To use Vim Python 2/3 plugins with Nvim, do the following:
|
|
|
|
- For Python 2 plugins, make sure an interpreter for Python 2.6 or 2.7 is
|
|
available in your `$PATH`, then install the `neovim` Python package systemwide:
|
|
>
|
|
$ sudo pip2 install neovim
|
|
<
|
|
or for the current user:
|
|
>
|
|
$ pip2 install --user neovim
|
|
<
|
|
- For Python 3 plugins, make sure an interpreter for Python 3.3 or above is
|
|
available in your `$PATH`, then install the `neovim` Python package systemwide:
|
|
>
|
|
$ sudo pip3 install neovim
|
|
<
|
|
or for the current user:
|
|
>
|
|
$ pip3 install --user neovim
|
|
<
|
|
Note: If you previously installed the package, get the latest version by
|
|
appending the `--upgrade` flag to the commands above.
|
|
|
|
==============================================================================
|
|
*g:python_host_prog*
|
|
|
|
To point Nvim to a specific Python 2 interpreter, set |g:python_host_prog|:
|
|
>
|
|
let g:python_host_prog = '/path/to/python'
|
|
<
|
|
*g:python3_host_prog*
|
|
|
|
To point Nvim to a specific Python 3 interpreter, set |g:python3_host_prog|:
|
|
>
|
|
let g:python3_host_prog = '/path/to/python3'
|
|
<
|
|
*g:loaded_python_provider*
|
|
|
|
To disable Python 2 interface, set `g:loaded_python_provider` to 1:
|
|
>
|
|
let g:loaded_python_provider = 1
|
|
<
|
|
*g:loaded_python3_provider*
|
|
|
|
To disable Python 3 interface, set `g:loaded_python3_provider` to 1:
|
|
>
|
|
let g:loaded_python3_provider = 1
|
|
<
|
|
*g:python_host_skip_check*
|
|
|
|
To disable Python 2 interpreter check, set `g:python_host_skip_check` to 1:
|
|
Note: If you disable Python 2 check, you must install neovim module properly.
|
|
>
|
|
let g:python_host_skip_check = 1
|
|
<
|
|
*g:python3_host_skip_check*
|
|
|
|
To disable Python 3 interpreter check, set `g:python3_host_skip_check` to 1:
|
|
Note: If you disable Python 3 check, you must install neovim module properly.
|
|
>
|
|
let g:python3_host_skip_check = 1
|
|
<
|
|
==============================================================================
|
|
3. Troubleshooting *nvim-python-troubleshooting*
|
|
|
|
If you are experiencing issues with a plugin that uses the `neovim` Python
|
|
client, you can use the |:CheckHealth| command to quickly rule out your setup
|
|
as a problem.
|
|
|
|
*:CheckHealth*
|
|
:CheckHealth[!] Check your setup for common problems that may be keeping a
|
|
plugin from functioning correctly. Including the output of
|
|
this command in bug reports can help reduce the amount of
|
|
time it takes to address your issue. If [!] is present, the
|
|
output will be placed in a new buffer which can make it
|
|
easier to save to a file or copy to the clipboard.
|
|
|
|
|
|
==============================================================================
|
|
vim:tw=78:ts=8:noet:ft=help:norl:
|