[PYTHON] Créer des plug-ins asynchrones avec neovim

Je souhaite effectuer un traitement asynchrone avec vim

--Vim lui-même ne peut pas créer un autre fil

• Faites de votre mieux avec vimproc + autocmd
• La gestion des rappels est difficile
• job/channel C'est un enfant que tu ne connais pas (ça a l'air bien)
• remote plugin ――Cette histoire aujourd'hui

Remote Plugin in neovim

--Nouvelles fonctionnalités de neovim

• Lancez le plug-in dans un processus séparé ――Neovim est sûr même si le processus de plug-in meurt!
• Communication mutuelle avec msgpack-rpc (asynchrone)
• En principe, vous pouvez écrire dans n'importe quelle langue!
• Adieu ʻif_python ou ʻif_lua! !!

msgpack-RPC?

--msgpack ~ = Version binaire de JSON

• RPC = remote procedure call
• Les fonctions sont exposées à l'extérieur ʻint func (int) `
• Le client peut être appelé comme un appel de fonction ʻa = client.call ("func", 2); `
• C'est OK si le serveur et le client peuvent convertir en msgpack même dans une autre langue ―― Le gRPC est-il plus populaire ces jours-ci? --Les deux neovim et le plugin envoient et reçoivent dans les deux sens

neovim server

• "The Nvim C API is automatically exposed to the RPC API by the build system" ――Vous pouvez tout faire (/ ・ ω ・) / ―― Appelons-le pour un essai --Démarrer avec NVIM_LISTEN_ADDRESS = 127.0.0.1:6666 nvim
• (Le client python ne prend pas en charge le socket UNIX) --neovim lui-même devient un client msgpack-RPC-> Article séparé

import mprpc
c = mprpc.RPCClient("localhost", 6666)
_, info = c.call("vim_get_api_info")
for f in info["functions"]:
    print(f["name"], f["parameters"], f["return_type"])

J'ai une liste de fonctions qui peuvent être appelées:

buffer_line_count (('Buffer', 'buffer'),) Integer
buffer_get_line (('Buffer', 'buffer'), ('Integer', 'index')) String
buffer_set_line (('Buffer', 'buffer'), ('Integer', 'index'), ('String', 'line')) void
buffer_del_line (('Buffer', 'buffer'), ('Integer', 'index')) void
buffer_get_line_slice (('Buffer', 'buffer'), ('Integer', 'start'), ('Integer', 'end'), ('Boolean', 'include_start'), ('Boolean', 'include_end')) ArrayOf(String)
buffer_get_lines (('Buffer', 'buffer'), ('Integer', 'start'), ('Integer', 'end'), ('Boolean', 'strict_indexing')) ArrayOf(String)
buffer_set_line_slice (('Buffer', 'buffer'), ('Integer', 'start'), ('Integer', 'end'), ('Boolean', 'include_start'), ('Boolean', 'include_end'), ('ArrayOf(String)', 'replacement')) void
buffer_set_lines (('Buffer', 'buffer'), ('Integer', 'start'), ('Integer', 'end'), ('Boolean', 'strict_indexing'), ('ArrayOf(String)', 'replacement')) void
buffer_get_var (('Buffer', 'buffer'), ('String', 'name')) Object
buffer_set_var (('Buffer', 'buffer'), ('String', 'name'), ('Object', 'value')) Object
buffer_del_var (('Buffer', 'buffer'), ('String', 'name')) Object
buffer_get_option (('Buffer', 'buffer'), ('String', 'name')) Object
buffer_set_option (('Buffer', 'buffer'), ('String', 'name'), ('Object', 'value')) void
buffer_get_number (('Buffer', 'buffer'),) Integer
buffer_get_name (('Buffer', 'buffer'),) String
buffer_set_name (('Buffer', 'buffer'), ('String', 'name')) void
buffer_is_valid (('Buffer', 'buffer'),) Boolean
buffer_insert (('Buffer', 'buffer'), ('Integer', 'lnum'), ('ArrayOf(String)', 'lines')) void
buffer_get_mark (('Buffer', 'buffer'), ('String', 'name')) ArrayOf(Integer, 2)
buffer_add_highlight (('Buffer', 'buffer'), ('Integer', 'src_id'), ('String', 'hl_group'), ('Integer', 'line'), ('Integer', 'col_start'), ('Integer', 'col_end')) Integer
buffer_clear_highlight (('Buffer', 'buffer'), ('Integer', 'src_id'), ('Integer', 'line_start'), ('Integer', 'line_end')) void
tabpage_get_windows (('Tabpage', 'tabpage'),) ArrayOf(Window)
tabpage_get_var (('Tabpage', 'tabpage'), ('String', 'name')) Object
tabpage_set_var (('Tabpage', 'tabpage'), ('String', 'name'), ('Object', 'value')) Object
tabpage_del_var (('Tabpage', 'tabpage'), ('String', 'name')) Object
tabpage_get_window (('Tabpage', 'tabpage'),) Window
tabpage_is_valid (('Tabpage', 'tabpage'),) Boolean
vim_command (('String', 'str'),) void
vim_feedkeys (('String', 'keys'), ('String', 'mode'), ('Boolean', 'escape_csi')) void
vim_input (('String', 'keys'),) Integer
vim_replace_termcodes (('String', 'str'), ('Boolean', 'from_part'), ('Boolean', 'do_lt'), ('Boolean', 'special')) String
vim_command_output (('String', 'str'),) String
vim_eval (('String', 'str'),) Object
vim_call_function (('String', 'fname'), ('Array', 'args')) Object
vim_strwidth (('String', 'str'),) Integer
vim_list_runtime_paths () ArrayOf(String)
vim_change_directory (('String', 'dir'),) void
vim_get_current_line () String
vim_set_current_line (('String', 'line'),) void
vim_del_current_line () void
vim_get_var (('String', 'name'),) Object
vim_set_var (('String', 'name'), ('Object', 'value')) Object
vim_del_var (('String', 'name'),) Object
vim_get_vvar (('String', 'name'),) Object
vim_get_option (('String', 'name'),) Object
vim_set_option (('String', 'name'), ('Object', 'value')) void
vim_out_write (('String', 'str'),) void
vim_err_write (('String', 'str'),) void
vim_report_error (('String', 'str'),) void
vim_get_buffers () ArrayOf(Buffer)
vim_get_current_buffer () Buffer
vim_set_current_buffer (('Buffer', 'buffer'),) void
vim_get_windows () ArrayOf(Window)
vim_get_current_window () Window
vim_set_current_window (('Window', 'window'),) void
vim_get_tabpages () ArrayOf(Tabpage)
vim_get_current_tabpage () Tabpage
vim_set_current_tabpage (('Tabpage', 'tabpage'),) void
vim_subscribe (('String', 'event'),) void
vim_unsubscribe (('String', 'event'),) void
vim_name_to_color (('String', 'name'),) Integer
vim_get_color_map () Dictionary
vim_get_api_info () Array
window_get_buffer (('Window', 'window'),) Buffer
window_get_cursor (('Window', 'window'),) ArrayOf(Integer, 2)
window_set_cursor (('Window', 'window'), ('ArrayOf(Integer, 2)', 'pos')) void
window_get_height (('Window', 'window'),) Integer
window_set_height (('Window', 'window'), ('Integer', 'height')) void
window_get_width (('Window', 'window'),) Integer
window_set_width (('Window', 'window'), ('Integer', 'width')) void
window_get_var (('Window', 'window'), ('String', 'name')) Object
window_set_var (('Window', 'window'), ('String', 'name'), ('Object', 'value')) Object
window_del_var (('Window', 'window'), ('String', 'name')) Object
window_get_option (('Window', 'window'), ('String', 'name')) Object
window_set_option (('Window', 'window'), ('String', 'name'), ('Object', 'value')) void
window_get_position (('Window', 'window'),) ArrayOf(Integer, 2)
window_get_tabpage (('Window', 'window'),) Tabpage
window_is_valid (('Window', 'window'),) Boolean

msgpack-RPC Puis-je écrire sans le savoir?

Ce n'est pas le cas: des SDK pour chaque langue sont en cours de développement

• Python : neovim/python-client
• Node.js : neovim/node-client
• Il existe de nombreux autres produits fabriqués par des tiers.
  • https://github.com/neovim/neovim/wiki/Related-projects#api-clients

Créer un plug-in avec neovim / python-client

Le sujet principal est d'ici. J'ai fait toggl.nvim et j'ai résumé ce que j'ai vérifié (même si c'était au milieu).

--Mettez le fichier dans $ runtimepath / rplugin / python3 / --Lorsque vous mettez un module, cela ne fonctionne pas bien à moins que vous ne mettiez un fichier vide.

rplugin/python3/toggl/...
                toggl.py  #Fichier vide

--Documenter moins

• Reportez-vous à deoplete.nvim
• Voir la source de python-client (relativement facile à voir)

--Neovim / python-client fera tout le travail lié au RPC | ω ・)

Comment utiliser python-client

Extrait de toggl.nvim

@neovim.plugin
class Toggl(object):

    def __init__(self, nvim):
        self.nvim = nvim
        self.api_token = nvim.eval("g:toggl_api_token")
        self.api = TogglAPI(self.api_token)

    @neovim.autocmd("VimEnter")
    def update(self):
        try:
            self.wid = self.api.workspaces()[0]["id"]
            self.projects = self.get_projects([])
        except ConnectionError:
            self.echo("No network, toggl.nvim is disabled.")

    def echo(self, msg):
        self.nvim.command("echo '{}'".format(msg))

    @neovim.function("TogglAPIToken", sync=True)
    def api_token(self, args):
        return self.api_token

    @neovim.function("TogglGetCurrent", sync=True)
    def get_current(self, args):
        return self.api.time_entries.current()

Vous pouvez écrire un plug-in vim simplement en définissant une classe + fonction avec un décorateur

• Vous pouvez obtenir une instance nvim en ajoutant neovim.plugin à la classe
• Vous pouvez lancer autocmd avec neovim.autocmd --Neovim.command peut être utilisé pour créer des commandes vim (les arguments sont automatiquement convertis en variables Python)
• Vous pouvez créer une fonction vim avec neovim.function
• Puisque le côté plug-in est un processus séparé, vous pouvez librement avoir l'état
• Appliquez les fonctions synchrones (sync = True) et asynchrones (sync = False, par défaut) de la même manière
• La bibliothèque Python peut être utilisée (requêtes)

Python est utilisé, mais le script vim est un peu ... Recommandé pour les gens!

finalement

--Qiita slide Facile et bon --osaka.vim amusant