[PYTHON] Asynchrone Plug-Ins mit neovim erstellen

Ich möchte eine asynchrone Verarbeitung mit vim durchführen

--Vim selbst kann keinen weiteren Thread erstellen

• Geben Sie Ihr Bestes mit vimproc + autocmd
• Rückrufverwaltung ist schwierig
• job/channel ――Es ist ein Kind, das du nicht kennst (sieht gut aus)
• remote plugin ――Diese Geschichte heute

Remote Plugin in neovim

• Neue Funktionen von Neovim
• Starten Sie das Plug-In in einem separaten Prozess ――Neovim ist sicher, auch wenn der Plug-In-Prozess abbricht!
• Gegenseitige Kommunikation mit msgpack-rpc (asynchron)
• Grundsätzlich können Sie in jeder Sprache schreiben!
• Abschied von if_python und if_lua! !!

msgpack-RPC?

--msgpack ~ = Binäre Version von JSON

• RPC = remote procedure call --Funktionen sind der Außenseite "int func (int)" ausgesetzt
• Der Client kann wie ein Funktionsaufruf "a = client.call (" func ", 2);" aufgerufen werden
• Es ist in Ordnung, wenn Server und Client auch in einer anderen Sprache in msgpack konvertieren können ――Ist gRPC heutzutage beliebter?
• Sowohl Neovim als auch Plugin senden und empfangen in beide Richtungen

neovim server

• "The Nvim C API is automatically exposed to the RPC API by the build system" ――Sie können alles tun (/ ・ ω ・) / »Rufen wir es für eine Gerichtsverhandlung an --Starten Sie mit NVIM_LISTEN_ADDRESS = 127.0.0.1:6666 nvim
• (Der Python-Client unterstützt keinen UNIX-Socket.) --neovim selbst wird zum msgpack-RPC-Client-> Separater Artikel

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"])

Ich habe eine Liste von Funktionen, die aufgerufen werden können:

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 Kann ich schreiben, ohne es zu wissen?

Das ist nicht der Fall: SDKs für jede Sprache werden entwickelt

• Python : neovim/python-client
• Node.js : neovim/node-client
• Es gibt viele andere Produkte von Drittanbietern.
  • https://github.com/neovim/neovim/wiki/Related-projects#api-clients

Erstellen Sie ein Plug-In mit neovim / python-client

Das Hauptthema ist von hier. Ich habe toggl.nvim erstellt und zusammengefasst, was ich überprüft habe (obwohl es in der Mitte war).

• Legen Sie die Datei in $ runtimepath / rplugin / python3 / ab
• Wenn Sie ein Modul einfügen, funktioniert es nur, wenn Sie eine leere Datei einfügen.

rplugin/python3/toggl/...
                toggl.py  #Leere Akte

--Dokument weniger

• Beziehen Sie sich auf deoplete.nvim --Siehe die Quelle des Python-Clients (relativ leicht zu sehen)

--Neovim / Python-Client erledigt alle RPC-bezogenen Arbeiten | ω ・)

Wie benutzt man Python-Client

Auszug aus 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()

Sie können ein vim-Plug-In schreiben, indem Sie eine Klasse + -Funktion mit einem Dekorator definieren

• Sie können die nvim-Instanz erhalten, indem Sie der Klasse neovim.plugin hinzufügen
• Sie können autocmd mit neovim.autocmd ausgeben --Neovim.command kann zum Erstellen von vim-Befehlen verwendet werden (Argumente werden automatisch in Python-Variablen konvertiert).
• Mit neovim.function können Sie eine vim-Funktion erstellen
• Da die Plug-In-Seite ein separater Prozess ist, können Sie den Status frei haben
• Wenden Sie sowohl synchrone (sync = True) als auch asynchrone Funktionen (sync = False, Standard) auf dieselbe Weise an
• Python-Bibliothek kann verwendet werden (Anfragen)

Python wird verwendet, aber VIM-Skript ist ein wenig ... Empfohlen für Leute!

Schließlich

--Qiita Folie Einfach und gut --osaka.vim Spaß