Full Code of jacobsimpson/nvim-example-python-plugin for AI

Repository: jacobsimpson/nvim-example-python-plugin
Branch: master
Commit: 0f99311d0e58
Files: 7
Total size: 9.8 KB

Directory structure:
gitextract_vtek_tuu/

├── .gitignore
├── LICENSE
├── README.md
├── doc/
│   ├── nvim-example-python-plugin.txt
│   └── tags
├── plugin/
│   └── nvim-example-python-plugin.vim
└── rplugin/
    └── python/
        └── nvim-example-python-plugin.py

================================================
FILE CONTENTS
================================================

================================================
FILE: .gitignore
================================================
.sw?
.*.sw?
*.pyc


================================================
FILE: LICENSE
================================================
This is free and unencumbered software released into the public domain.

Anyone is free to copy, modify, publish, use, compile, sell, or
distribute this software, either in source code form or as a compiled
binary, for any purpose, commercial or non-commercial, and by any
means.

In jurisdictions that recognize copyright laws, the author or authors
of this software dedicate any and all copyright interest in the
software to the public domain. We make this dedication for the benefit
of the public at large and to the detriment of our heirs and
successors. We intend this dedication to be an overt act of
relinquishment in perpetuity of all present and future rights to this
software under copyright law.

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 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.

For more information, please refer to <http://unlicense.org>



================================================
FILE: README.md
================================================
# Example Neovim Python Plugin

- [Introduction](#introduction)
- [Installing](#installing)
    - [Downloading](#downloading)
    - [Configuring Vim](#configuring-vim)
    - [Python Version](#python_version)
    - [Initializing Vim with Remote Plugin](#initializing)
    - [Testing the New Plugin](#testing)
- [Development](#development)
    - [Debugging](#debugging)
    - [Plugin Interface Changes](#changing-interface)
- [Troubleshooting](#troubleshooting)
    - [Refreshing the Manifest File](#refreshing-manifest)
    - [Python Client Log File](#client-log-file)
    - [Neovim Log File](#neovim-log-file)
    - [Neovim Library](#neovim-library)
- [References](#references)

## <a id="introduction"></a>Introduction

As part of the changes included in Neovim there is a new plugin model where
plugins are separate processes which Neovim communicates to using the
MessagePack protocol.

Since plugins are distinct from the Neovim process, it is possible to write
plugins in many languages.

This is a minimal example of a Python plugin. When you want to create a new
Python plugin, you should be able to (and feel free to) copy this repository,
rename a couple files, include the plugin in your Vim config and see something
happen.

## <a id="installing"></a>Installing

### <a id="downloading"></a>Downloading

The intention of this repository is to make it quick and easy to start a new
plugin. It is just enough to show how to make the basics work.

```Bash
git clone --depth 1 https://github.com/jacobsimpson/nvim-example-python-plugin ~/.vim/bundle/nvim-example-python-plugin
rm -Rf ~/.vim/bundle/nvim-example-python-plugin/.git
```

### <a id="configuring-vim"></a>Configuring Vim

I use NeoBundle so this is an example of how to load this plugin in NeoBundle.

```VimL
" Required:
call neobundle#begin(expand('~/.vim/bundle/'))

    " Let NeoBundle manage NeoBundle
    " Required:
    NeoBundleFetch 'Shougo/neobundle.vim'

    " You probably have a number of other plugins listed here.

    " Add this line to make your new plugin load, assuming you haven't renamed it.
    NeoBundle 'nvim-example-python-plugin'
call neobundle#end()
```

If you use vim-plug, you can add this line to your plugin section:

```VimL
Plug 'jacobsimpson/nvim-example-python-plugin'
```

After running `:PlugInstall`, the files should appear in your `~/.config/nvim/plugged` directory (or whatever path you have configured for plugins).

### <a id="python_version"></a>Python Version

This plugin code works with Python 2. You can make it work with Python 3 by changing the `rplugin/python` directory to be `rplugin/python3`. See the [python-client remote plugin documentation](https://github.com/neovim/python-client#remote-new-style-plugins) for more information.

### <a id="initializing"></a>Initializing Vim with Remote Plugin

The next thing to do is to initialize the manifest for the Python part of the
plugin. The manifest is a cache that Vim keeps of the interface implemented by
the Python part of the plugin. The functions and commands it implements.

To initialize the manifest, execute:

```VimL
:UpdateRemotePlugins
```

**NOTE:** After initializing the manifest, you must restart neovim for the python
functions be be available.

### <a id="testing"></a>Testing the New Plugin

There is some VimL in the plugin that will print when Neovim is starting up:

    Starting the example Python Plugin

That will confirm that the VimL portions of the plugin are loading correctly.

There is a function defined in the VimL portion of the plugin which echos some
text. You can execute the function like this:

```VimL
:exec DoItVimL()
```

Now that the manifest is initialized, it should be possible to invoke the
function defined in the Python part of the plugin. Look in \_\_init\_\_ to see
the implementation.

```VimL
:exec DoItPython()
```

## <a id="development"></a>Development

On it's own, this plugin doesn't do anything interesting, so the expectation is
that you will want to modify it.

### <a id="debugging"></a>Debugging

In order to take advantage of the Python REPL and make it easier to test changes in your Python code, I usually take the following steps:

1. Open a Neovim instance.
2. Open a terminal inside Neovim. (:term)
3. Start the Python, or IPython, interpreter in the Neovim terminal. (python, ipython)
4. Execute this code in the Python interpreter:
```Python
import neovim
import os

nvim = neovim.attach('socket', path=os.environ['NVIM_LISTEN_ADDRESS'])
```

At this point, you can either execute commands directly against Neovim, to test the behavior of the interface:

```Python
nvim.current.buffer.name
```

or load your own plugin class and work with it directly.

```Python
%run "rplugin/python/nvim-example-python-plugin.py"
m = Main(nvim)
m.doItPython([])
```

### <a id="changing-interface"></a>Plugin Interface Changes

Neovim includes a step where the interface of the remote plugin is cached for
Neovim, so that Neovim knows what functions and commands your plugin is making
available without having to wait while the external process containing the
plugin is started.

```VimL
:UpdateRemotePlugins
```

Run this command for *every* change in the plugin interface. Without this, you
may see errors on from Neovim telling you methods are missing from your plugin.
Or the new functionality you are trying to add just won't work.

## <a id="troubleshooting"></a>Troubleshooting

### <a id="refreshing-manifest"></a>Refreshing the Manifest File

For each change to the interface of the Python plugin, that is to say, any
alterations to the @neovim decorators, you need to update Neovim's manifest
file:

```VimL
:UpdateRemotePlugins
```

Restart Neovim after you update to make the changes take effect.

If there is a syntax error in the Python file, it may result in the plugin not
loading. There may be no visible error. If you run the update command, and the
commands and functions defined in the remote plugin are not available, the next
useful troubleshooting step is to load your plugin directly in a Python
interpreter to see if it works.

### <a id="client-log-file"></a>Python Client Log File

Define this environment variable to get output logged from your Python client.

```Bash
export NVIM_PYTHON_LOG_FILE=${HOME}/.nvim-python.log
```

The output files will have a number appended, and should be visible with this:

```Bash
ls ${HOME}/.nvim-python.log*
```

### <a id="neovim-log-file"></a>Neovim Log File

```Bash
ls ~/.nvimlog
```

### <a id="neovim-library"></a>Neovim Library

One problem I encountered when I was first getting started was the Python
neovim module was not installed on my system. I didn't see any great errors
that lead me to that conclusion, so it is worth checking:

```Bash
python -c "import neovim"
```

Should execute without an error.

## <a id="references"></a>References
- [Neovim Remote Plugin Documentation](http://neovim.io/doc/user/remote_plugin.html)

The Neovim docs for remote plugins. It's a little sparse, but captures the core
detail.

- [Neovim Python Client](https://github.com/neovim/python-client)

The Neovim Python client is the Python API that wraps the MessagePack protocol
Neovim uses to communicate with remote plugins. If you are looking for more
information on how to use the vim parameter to the main object to control
Neovim, this is the place to go.


================================================
FILE: doc/nvim-example-python-plugin.txt
================================================
*nvim-example-python-plugin.txt* A template of a remote Python plugin.

                  Example Remote Python Plugin

==============================================================================

CONTENTS                                 *nvim-example-python-plugin-contents*

    1. Introduction .................... |nvim-example-python-plugin-intro|


Original Author:    Jacob Simpson
License:            The Unlicense

INTRODUCTION                                *nvim-example-python-plugin-intro*

A very simple example of a Python plugin in the new remote plugin style used by
Neovim.



================================================
FILE: doc/tags
================================================
nvim-example-python-plugin-contents	nvim-example-python-plugin.txt	/*nvim-example-python-plugin-contents*
nvim-example-python-plugin-intro	nvim-example-python-plugin.txt	/*nvim-example-python-plugin-intro*
nvim-example-python-plugin.txt	nvim-example-python-plugin.txt	/*nvim-example-python-plugin.txt*


================================================
FILE: plugin/nvim-example-python-plugin.vim
================================================

" The VimL/VimScript code is included in this sample plugin to demonstrate the
" two different approaches but it is not required you use VimL. Feel free to
" delete this code and proceed without it.

echo "Starting the example Python Plugin"

function DoItVimL()
    echo "hello from DoItVimL"
endfunction


================================================
FILE: rplugin/python/nvim-example-python-plugin.py
================================================
import neovim

@neovim.plugin
class Main(object):
    def __init__(self, vim):
        self.vim = vim

    @neovim.function('DoItPython')
    def doItPython(self, args):
        self.vim.command('echo "hello from DoItPython"')