Plugin Decorators

Plugin decorators.

Plugin

pynvim.plugin.plugin(cls)[source]

Tag a class as a plugin.

This decorator is required to make the class methods discoverable by the plugin_load method of the host.

Command

pynvim.plugin.command(name, nargs=0, complete=None, range=None, count=None, bang=False, register=False, sync=False, allow_nested=False, eval=None)[source]

Tag a function or plugin method as a Nvim command handler.

Autocmd

pynvim.plugin.autocmd(name, pattern='*', sync=False, allow_nested=False, eval=None)[source]

Tag a function or plugin method as a Nvim autocommand handler.

Function

pynvim.plugin.function(name, range=False, sync=False, allow_nested=False, eval=None)[source]

Tag a function or plugin method as a Nvim function handler.