Nvim.request() - Code Metrics - Inspection of "nvim: show errors in handler on stderr when used a..." - neovim/python-client - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#217)

by Björn

created 2016-07-21 11:50 UTC

Nvim.request() B

↳ Parent: Nvim

Complexity

Conditions

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	5
CRAP Score	1

Importance

Changes

Metric	Value
cc	1
dl	0
loc	24
ccs	5
cts	5
cp	1
crap	1
rs	8.9713
c	0
b	0
f	0

"""Main Nvim interface."""
import functools
import os
import sys

from traceback import format_stack

from msgpack import ExtType
# .scrutinizer.yml
before_commands:
    - sudo pip install abc # Python2
    - sudo pip3 install abc # Python3

from .buffer import Buffer
from .common import (Remote, RemoteApi, RemoteMap, RemoteSequence,
                     decode_if_bytes, walk)
from .tabpage import Tabpage
from .window import Window
from ..compat import IS_PYTHON3
from ..util import format_exc_skip

__all__ = ('Nvim')


os_chdir = os.chdir


class Nvim(object):

    """Class that represents a remote Nvim instance.

    This class is main entry point to Nvim remote API, it is a wrapper
    around Session instances.

    The constructor of this class must not be called directly. Instead, the
    `from_session` class method should be used to create the first instance
    from a raw `Session` instance.

    Subsequent instances for the same session can be created by calling the
    `with_decode` instance method to change the decoding behavior or
    `SubClass.from_nvim(nvim)` where `SubClass` is a subclass of `Nvim`, which
    is useful for having multiple `Nvim` objects that behave differently
    without one affecting the other.
    """

    @classmethod
    def from_session(cls, session):
        """Create a new Nvim instance for a Session instance.

        This method must be called to create the first Nvim instance, since it
        queries Nvim metadata for type information and sets a SessionHook for
        creating specialized objects from Nvim remote handles.
        """
        session.error_wrapper = lambda e: NvimError(e[1])
        channel_id, metadata = session.request(b'vim_get_api_info')

        if IS_PYTHON3:
            # decode all metadata strings for python3
            metadata = walk(decode_if_bytes, metadata)

        types = {
            metadata['types']['Buffer']['id']: Buffer,
            metadata['types']['Window']['id']: Window,
            metadata['types']['Tabpage']['id']: Tabpage,
        }

        return cls(session, channel_id, metadata, types)

    @classmethod
    def from_nvim(cls, nvim):
        """Create a new Nvim instance from an existing instance."""
        return cls(nvim._session, nvim.channel_id, nvim.metadata,
class MyParent:
    def __init__(self):
        self._x = 1;
        self.y = 2;

class MyChild(MyParent):
    def some_method(self):
        return self._x    # Ok, since accessed from a child class

class AnotherClass:
    def some_method(self, instance_of_my_child):
        return instance_of_my_child._x   # Would be flagged as AnotherClass is not
                                         # a child class of MyParent
                   nvim.types, nvim._decode, nvim._err_cb)
class MyParent:
    def __init__(self):
        self._x = 1;
        self.y = 2;

class MyChild(MyParent):
    def some_method(self):
        return self._x    # Ok, since accessed from a child class

class AnotherClass:
    def some_method(self, instance_of_my_child):
        return instance_of_my_child._x   # Would be flagged as AnotherClass is not
                                         # a child class of MyParent

    def __init__(self, session, channel_id, metadata, types,
                 decode=False, err_cb=None):
        """Initialize a new Nvim instance. This method is module-private."""
        self._session = session
        self.channel_id = channel_id
        self.metadata = metadata
        self.types = types
        self.api = RemoteApi(self, 'vim_')
        self.vars = RemoteMap(self, 'vim_get_var', 'vim_set_var')
        self.vvars = RemoteMap(self, 'vim_get_vvar', None)
        self.options = RemoteMap(self, 'vim_get_option', 'vim_set_option')
        self.buffers = Buffers(self)
        self.windows = RemoteSequence(self, 'vim_get_windows')
        self.tabpages = RemoteSequence(self, 'vim_get_tabpages')
        self.current = Current(self)
        self.session = CompatibilitySession(self)
        self.funcs = Funcs(self)
        self.error = NvimError
        self._decode = decode
        self._err_cb = err_cb

    def _from_nvim(self, obj, decode=None):
        if decode is None:
            decode = self._decode
        if type(obj) is ExtType:
            cls = self.types[obj.code]
            return cls(self, (obj.code, obj.data))
        if decode:
            obj = decode_if_bytes(obj, decode)
        return obj

    def _to_nvim(self, obj):
class Foo:
    def some_method(self, x, y):
        return x + y;
        if isinstance(obj, Remote):
            return ExtType(*obj.code_data)
        return obj

    def request(self, name, *args, **kwargs):
        r"""Send an API request or notification to nvim.

        It is rarely needed to call this function directly, as most API
        functions have python wrapper functions. The `api` object can
        be also be used to call API functions as methods:

            vim.api.err_write('ERROR\n', async=True)
            vim.current.buffer.api.get_mark('.')

        is equivalent to

            vim.request('vim_err_write', 'ERROR\n', async=True)
            vim.request('buffer_get_mark', vim.current.buffer, '.')


        Normally a blocking request will be sent.  If the `async` flag is
        present and True, a asynchronous notification is sent instead. This
        will never block, and the return value or error is ignored.
        """
        decode = kwargs.pop('decode', self._decode)
        args = walk(self._to_nvim, args)
        res = self._session.request(name, *args, **kwargs)
        return walk(self._from_nvim, res, decode=decode)

    def next_message(self):
        """Block until a message(request or notification) is available.

        If any messages were previously enqueued, return the first in queue.
        If not, run the event loop until one is received.
        """
        msg = self._session.next_message()
        if msg:
            return walk(self._from_nvim, msg)

    def run_loop(self, request_cb, notification_cb,
                 setup_cb=None, err_cb=None):
        """Run the event loop to receive requests and notifications from Nvim.

        This should not be called from a plugin running in the host, which
        already runs the loop and dispatches events to plugins.
        """
        if err_cb is None:
            err_cb = sys.stderr.write
        self._err_cb = err_cb

        def filter_request_cb(name, args):
            name = self._from_nvim(name)
            args = walk(self._from_nvim, args)
            try:
                result = request_cb(name, args)
            except Exception:
                msg = ("error caught in request handler '{} {}'\n{}\n\n"
                       .format(name, args, format_exc_skip(1, 5)))
                self._err_cb(msg)
                raise
            return walk(self._to_nvim, result)

        def filter_notification_cb(name, args):
            name = self._from_nvim(name)
            args = walk(self._from_nvim, args)
            try:
                notification_cb(name, args)
            except Exception:
                msg = ("error caught in notification handler '{} {}'\n{}\n\n"
                       .format(name, args, format_exc_skip(1, 5)))
                self._err_cb(msg)
                raise


        self._session.run(filter_request_cb, filter_notification_cb, setup_cb)

    def stop_loop(self):
        """Stop the event loop being started with `run_loop`."""
        self._session.stop()

    def with_decode(self, decode=True):
        """Initialize a new Nvim instance."""
        return Nvim(self._session, self.channel_id,
                    self.metadata, self.types, decode, self._err_cb)

    def ui_attach(self, width, height, rgb):
        """Register as a remote UI.

        After this method is called, the client will receive redraw
        notifications.
        """
        return self.request('ui_attach', width, height, rgb)

    def ui_detach(self):
        """Unregister as a remote UI."""
        return self.request('ui_detach')

    def ui_try_resize(self, width, height):
        """Notify nvim that the client window has resized.

        If possible, nvim will send a redraw request to resize.
        """
        return self.request('ui_try_resize', width, height)

    def subscribe(self, event):
        """Subscribe to a Nvim event."""
        return self.request('vim_subscribe', event)

    def unsubscribe(self, event):
        """Unsubscribe to a Nvim event."""
        return self.request('vim_unsubscribe', event)

    def command(self, string, **kwargs):
        """Execute a single ex command."""
        return self.request('vim_command', string, **kwargs)

    def command_output(self, string):
        """Execute a single ex command and return the output."""
        return self.request('vim_command_output', string)

    def eval(self, string, **kwargs):
        """Evaluate a vimscript expression."""
        return self.request('vim_eval', string, **kwargs)

    def call(self, name, *args, **kwargs):
        """Call a vimscript function."""
        return self.request('vim_call_function', name, args, **kwargs)

    def strwidth(self, string):
        """Return the number of display cells `string` occupies.

        Tab is counted as one cell.
        """
        return self.request('vim_strwidth', string)

    def list_runtime_paths(self):
        """Return a list of paths contained in the 'runtimepath' option."""
        return self.request('vim_list_runtime_paths')

    def foreach_rtp(self, cb):
        """Invoke `cb` for each path in 'runtimepath'.

        Call the given callable for each path in 'runtimepath' until either
        callable returns something but None, the exception is raised or there
        are no longer paths. If stopped in case callable returned non-None,
        vim.foreach_rtp function returns the value returned by callable.
        """
        for path in self.request('vim_list_runtime_paths'):
            try:
                if cb(path) is not None:
                    break
            except Exception:

                break

    def chdir(self, dir_path):
        """Run os.chdir, then all appropriate vim stuff."""
        os_chdir(dir_path)
        return self.request('vim_change_directory', dir_path)

    def feedkeys(self, keys, options='', escape_csi=True):
        """Push `keys` to Nvim user input buffer.

        Options can be a string with the following character flags:
        - 'm': Remap keys. This is default.
        - 'n': Do not remap keys.
        - 't': Handle keys as if typed; otherwise they are handled as if coming
               from a mapping. This matters for undo, opening folds, etc.
        """
        return self.request('vim_feedkeys', keys, options, escape_csi)

    def input(self, bytes):

        """Push `bytes` to Nvim low level input buffer.

        Unlike `feedkeys()`, this uses the lowest level input buffer and the
        call is not deferred. It returns the number of bytes actually
        written(which can be less than what was requested if the buffer is
        full).
        """
        return self.request('vim_input', bytes)

    def replace_termcodes(self, string, from_part=False, do_lt=True,
                          special=True):
        r"""Replace any terminal code strings by byte sequences.

        The returned sequences are Nvim's internal representation of keys,
        for example:

        <esc> -> '\x1b'
        <cr>  -> '\r'
        <c-l> -> '\x0c'
        <up>  -> '\x80ku'

        The returned sequences can be used as input to `feedkeys`.
        """
        return self.request('vim_replace_termcodes', string,
                            from_part, do_lt, special)

    def out_write(self, msg):
        """Print `msg` as a normal message."""
        return self.request('vim_out_write', msg)

    def err_write(self, msg, **kwargs):
        """Print `msg` as an error message."""
        return self.request('vim_err_write', msg, **kwargs)

    def quit(self, quit_command='qa!'):
        """Send a quit command to Nvim.

        By default, the quit command is 'qa!' which will make Nvim quit without
        saving anything.
        """
        try:
            self.command(quit_command)
        except IOError:
try:
    raises_exception()
except:  # Could be removed
    pass
            # sending a quit command will raise an IOError because the
            # connection is closed before a response is received. Safe to
            # ignore it.
            pass

    def new_highlight_source(self):
        """Return new src_id for use with Buffer.add_highlight."""
        return self.current.buffer.add_highlight("", 0, src_id=0)

    def async_call(self, fn, *args, **kwargs):
        """Schedule `fn` to be called by the event loop soon.

        This function is thread-safe, and is the only way code not
        on the main thread could interact with nvim api objects.

        This function can also be called in a synchronous
        event handler, just before it returns, to defer execution
        that shouldn't block neovim.
        """
        call_point = ''.join(format_stack(None, 5)[:-1])

        def handler():
            try:
                fn(*args, **kwargs)
            except Exception as err:
                msg = ("error caught while executing async callback:\n"
                       "{0!r}\n{1}\n \nthe call was requested at\n{2}"
                       .format(err, format_exc_skip(1, 5), call_point))
                self._err_cb(msg)
                raise
        self._session.threadsafe_call(handler)


class Buffers(object):

    """Remote NVim buffers.

    Currently the interface for interacting with remote NVim buffers is the
    `vim_get_buffers` msgpack-rpc function. Most methods fetch the list of
    buffers from NVim.

    Conforms to *python-buffers*.
    """

    def __init__(self, nvim):
        """Initialize a Buffers object with Nvim object `nvim`."""
        self._fetch_buffers = nvim.api.get_buffers

    def __len__(self):
        """Return the count of buffers."""
        return len(self._fetch_buffers())

    def __getitem__(self, number):
        """Return the Buffer object matching buffer number `number`."""
        for b in self._fetch_buffers():
            if b.number == number:
                return b
        raise KeyError(number)

    def __contains__(self, b):
        """Return whether Buffer `b` is a known valid buffer."""
        return isinstance(b, Buffer) and b.valid

    def __iter__(self):
        """Return an iterator over the list of buffers."""
        return iter(self._fetch_buffers())


class CompatibilitySession(object):

    """Helper class for API compatibility."""

    def __init__(self, nvim):
        self.threadsafe_call = nvim.async_call


class Current(object):

    """Helper class for emulating vim.current from python-vim."""

    def __init__(self, session):
        self._session = session
        self.range = None

    @property
    def line(self):
        return self._session.request('vim_get_current_line')

    @line.setter
    def line(self, line):
        return self._session.request('vim_set_current_line', line)

    @property
    def buffer(self):
        return self._session.request('vim_get_current_buffer')

    @buffer.setter
    def buffer(self, buffer):
        return self._session.request('vim_set_current_buffer', buffer)

    @property
    def window(self):
        return self._session.request('vim_get_current_window')

    @window.setter
    def window(self, window):
        return self._session.request('vim_set_current_window', window)

    @property
    def tabpage(self):
        return self._session.request('vim_get_current_tabpage')

    @tabpage.setter
    def tabpage(self, tabpage):
        return self._session.request('vim_set_current_tabpage', tabpage)


class Funcs(object):

    """Helper class for functional vimscript interface."""

    def __init__(self, nvim):
        self._nvim = nvim

    def __getattr__(self, name):
        return functools.partial(self._nvim.call, name)


class NvimError(Exception):
    pass


Pull Request — master (#217)

Nvim.request() B

Complexity

Size

Duplication

Code Coverage

Importance

1. Missing Dependencies

2. Missing init.py files

1		"""Main Nvim interface."""
2	6	import functools
3	6	import os
4	6	import sys
5
6	6	from traceback import format_stack
7
8	6	from msgpack import ExtType
		0 ignored issues – show Configuration introduced 2015-12-02 06:47 UTC by Report Bug Copy Issue Report The import `msgpack` could not be resolved. This can be caused by one of the following: 1. Missing Dependencies This error could indicate a configuration issue of Pylint. Make sure that your libraries are available by adding the necessary commands. # .scrutinizer.yml before_commands: - sudo pip install abc # Python2 - sudo pip3 install abc # Python3 Tip: We are currently not using virtualenv to run pylint, when installing your modules make sure to use the command for the correct version. 2. Missing __init__.py files This error could also result from missing `__init__.py` files in your module folders. Make sure that you place one file in each sub-folder. Loading history...
9
10	6	from .buffer import Buffer
11	6	from .common import (Remote, RemoteApi, RemoteMap, RemoteSequence,
12		decode_if_bytes, walk)
13	6	from .tabpage import Tabpage
14	6	from .window import Window
15	6	from ..compat import IS_PYTHON3
16	6	from ..util import format_exc_skip
17
18	6	__all__ = ('Nvim')
19
20
21	6	os_chdir = os.chdir
22
23
24	6	class Nvim(object):
25
26		"""Class that represents a remote Nvim instance.
27
28		This class is main entry point to Nvim remote API, it is a wrapper
29		around Session instances.
30
31		The constructor of this class must not be called directly. Instead, the
32		`from_session` class method should be used to create the first instance
33		from a raw `Session` instance.
34
35		Subsequent instances for the same session can be created by calling the
36		`with_decode` instance method to change the decoding behavior or
37		`SubClass.from_nvim(nvim)` where `SubClass` is a subclass of `Nvim`, which
38		is useful for having multiple `Nvim` objects that behave differently
39		without one affecting the other.
40		"""
41
42	6	@classmethod
43		def from_session(cls, session):
44		"""Create a new Nvim instance for a Session instance.
45
46		This method must be called to create the first Nvim instance, since it
47		queries Nvim metadata for type information and sets a SessionHook for
48		creating specialized objects from Nvim remote handles.
49		"""
50	6	session.error_wrapper = lambda e: NvimError(e[1])
51	6	channel_id, metadata = session.request(b'vim_get_api_info')
52
53	6	if IS_PYTHON3:
54		# decode all metadata strings for python3
55	6	metadata = walk(decode_if_bytes, metadata)
56
57	6	types = {
58		metadata['types']['Buffer']['id']: Buffer,
59		metadata['types']['Window']['id']: Window,
60		metadata['types']['Tabpage']['id']: Tabpage,
61		}
62
63	6	return cls(session, channel_id, metadata, types)
64
65	6	@classmethod
66		def from_nvim(cls, nvim):
67		"""Create a new Nvim instance from an existing instance."""
68		return cls(nvim._session, nvim.channel_id, nvim.metadata,
		0 ignored issues – show Coding Style Best Practice introduced 2016-03-20 16:11 UTC by Report Bug Copy Issue Report It seems like `_session` was declared protected and should not be accessed from this context. Prefixing a member variable `_` is usually regarded as the equivalent of declaring it with protected visibility that exists in other languages. Consequentially, such a member should only be accessed from the same class or a child class: class MyParent: def __init__(self): self._x = 1; self.y = 2; class MyChild(MyParent): def some_method(self): return self._x # Ok, since accessed from a child class class AnotherClass: def some_method(self, instance_of_my_child): return instance_of_my_child._x # Would be flagged as AnotherClass is not # a child class of MyParent Loading history...
69		nvim.types, nvim._decode, nvim._err_cb)
		0 ignored issues – show Coding Style Best Practice introduced 2016-03-24 17:40 UTC by Report Bug Copy Issue Report It seems like `_decode` was declared protected and should not be accessed from this context. Prefixing a member variable `_` is usually regarded as the equivalent of declaring it with protected visibility that exists in other languages. Consequentially, such a member should only be accessed from the same class or a child class: class MyParent: def __init__(self): self._x = 1; self.y = 2; class MyChild(MyParent): def some_method(self): return self._x # Ok, since accessed from a child class class AnotherClass: def some_method(self, instance_of_my_child): return instance_of_my_child._x # Would be flagged as AnotherClass is not # a child class of MyParent Loading history... Coding Style Best Practice introduced 2016-03-20 11:50 UTC by Report Bug Copy Issue Report It seems like `_err_cb` was declared protected and should not be accessed from this context. Prefixing a member variable `_` is usually regarded as the equivalent of declaring it with protected visibility that exists in other languages. Consequentially, such a member should only be accessed from the same class or a child class: class MyParent: def __init__(self): self._x = 1; self.y = 2; class MyChild(MyParent): def some_method(self): return self._x # Ok, since accessed from a child class class AnotherClass: def some_method(self, instance_of_my_child): return instance_of_my_child._x # Would be flagged as AnotherClass is not # a child class of MyParent Loading history...
70
71	6	def __init__(self, session, channel_id, metadata, types,
72		decode=False, err_cb=None):
73		"""Initialize a new Nvim instance. This method is module-private."""
74	6	self._session = session
75	6	self.channel_id = channel_id
76	6	self.metadata = metadata
77	6	self.types = types
78	6	self.api = RemoteApi(self, 'vim_')
79	6	self.vars = RemoteMap(self, 'vim_get_var', 'vim_set_var')
80	6	self.vvars = RemoteMap(self, 'vim_get_vvar', None)
81	6	self.options = RemoteMap(self, 'vim_get_option', 'vim_set_option')
82	6	self.buffers = Buffers(self)
83	6	self.windows = RemoteSequence(self, 'vim_get_windows')
84	6	self.tabpages = RemoteSequence(self, 'vim_get_tabpages')
85	6	self.current = Current(self)
86	6	self.session = CompatibilitySession(self)
87	6	self.funcs = Funcs(self)
88	6	self.error = NvimError
89	6	self._decode = decode
90	6	self._err_cb = err_cb
91
92	6	def _from_nvim(self, obj, decode=None):
93	6	if decode is None:
94	6	decode = self._decode
95	6	if type(obj) is ExtType:
96	6	cls = self.types[obj.code]
97	6	return cls(self, (obj.code, obj.data))
98	6	if decode:
99	4	obj = decode_if_bytes(obj, decode)
100	6	return obj
101
102	6	def _to_nvim(self, obj):
		0 ignored issues – show Coding Style introduced 2016-03-06 13:35 UTC by Report Bug Copy Issue Report This method could be written as a function/class method. If a method does not access any attributes of the class, it could also be implemented as a function or static method. This can help improve readability. For example class Foo: def some_method(self, x, y): return x + y; could be written as class Foo: @classmethod def some_method(cls, x, y): return x + y; Loading history...
103	6	if isinstance(obj, Remote):
104	6	return ExtType(*obj.code_data)
105	6	return obj
106
107	6	def request(self, name, args, *kwargs):
108		r"""Send an API request or notification to nvim.
109
110		It is rarely needed to call this function directly, as most API
111		functions have python wrapper functions. The `api` object can
112		be also be used to call API functions as methods:
113
114		vim.api.err_write('ERROR\n', async=True)
115		vim.current.buffer.api.get_mark('.')
116
117		is equivalent to
118
119		vim.request('vim_err_write', 'ERROR\n', async=True)
120		vim.request('buffer_get_mark', vim.current.buffer, '.')
121
122
123		Normally a blocking request will be sent. If the `async` flag is
124		present and True, a asynchronous notification is sent instead. This
125		will never block, and the return value or error is ignored.
126		"""
127	6	decode = kwargs.pop('decode', self._decode)
128	6	args = walk(self._to_nvim, args)
129	6	res = self._session.request(name, args, *kwargs)
130	6	return walk(self._from_nvim, res, decode=decode)
131
132	6	def next_message(self):
133		"""Block until a message(request or notification) is available.
134
135		If any messages were previously enqueued, return the first in queue.
136		If not, run the event loop until one is received.
137		"""
138	6	msg = self._session.next_message()
139	6	if msg:
140	6	return walk(self._from_nvim, msg)
141
142	6	def run_loop(self, request_cb, notification_cb,
143		setup_cb=None, err_cb=None):
144		"""Run the event loop to receive requests and notifications from Nvim.
145
146		This should not be called from a plugin running in the host, which
147		already runs the loop and dispatches events to plugins.
148		"""
149	6	if err_cb is None:
150	6	err_cb = sys.stderr.write
151	6	self._err_cb = err_cb
152	6
153		def filter_request_cb(name, args):
154	6	name = self._from_nvim(name)
155		args = walk(self._from_nvim, args)
156		try:
157	6	result = request_cb(name, args)
158	6	except Exception:
159	6	msg = ("error caught in request handler '{} {}'\n{}\n\n"
160		.format(name, args, format_exc_skip(1, 5)))
161	6	self._err_cb(msg)
162		raise
163	6	return walk(self._to_nvim, result)
164
165	6	def filter_notification_cb(name, args):
166		name = self._from_nvim(name)
167	6	args = walk(self._from_nvim, args)
168		try:
169	6	notification_cb(name, args)
170		except Exception:
171		msg = ("error caught in notification handler '{} {}'\n{}\n\n"
172	6	.format(name, args, format_exc_skip(1, 5)))
173		self._err_cb(msg)
174		raise
175
176
177		self._session.run(filter_request_cb, filter_notification_cb, setup_cb)
178
179		def stop_loop(self):
180	6	"""Stop the event loop being started with `run_loop`."""
181		self._session.stop()
182
183		def with_decode(self, decode=True):
184	6	"""Initialize a new Nvim instance."""
185		return Nvim(self._session, self.channel_id,
186		self.metadata, self.types, decode, self._err_cb)
187
188		def ui_attach(self, width, height, rgb):
189		"""Register as a remote UI.
190
191	6	After this method is called, the client will receive redraw
192		notifications.
193	6	"""
194		return self.request('ui_attach', width, height, rgb)
195	6
196		def ui_detach(self):
197	6	"""Unregister as a remote UI."""
198		return self.request('ui_detach')
199	6
200		def ui_try_resize(self, width, height):
201	6	"""Notify nvim that the client window has resized.
202
203	6	If possible, nvim will send a redraw request to resize.
204		"""
205		return self.request('ui_try_resize', width, height)
206
207	6	def subscribe(self, event):
208		"""Subscribe to a Nvim event."""
209	6	return self.request('vim_subscribe', event)
210
211	6	def unsubscribe(self, event):
212		"""Unsubscribe to a Nvim event."""
213	6	return self.request('vim_unsubscribe', event)
214
215	6	def command(self, string, **kwargs):
216		"""Execute a single ex command."""
217		return self.request('vim_command', string, **kwargs)
218
219		def command_output(self, string):
220	6	"""Execute a single ex command and return the output."""
221		return self.request('vim_command_output', string)
222	6
223		def eval(self, string, **kwargs):
224		"""Evaluate a vimscript expression."""
225		return self.request('vim_eval', string, **kwargs)
226	6
227		def call(self, name, args, *kwargs):
228		"""Call a vimscript function."""
229		return self.request('vim_call_function', name, args, **kwargs)
230
231		def strwidth(self, string):
232		"""Return the number of display cells `string` occupies.
233
234		Tab is counted as one cell.
235	1	"""
236	1	return self.request('vim_strwidth', string)
237
238		def list_runtime_paths(self):
239		"""Return a list of paths contained in the 'runtimepath' option."""
240		return self.request('vim_list_runtime_paths')
241	6
242		def foreach_rtp(self, cb):
243	6	"""Invoke `cb` for each path in 'runtimepath'.
244	6
245		Call the given callable for each path in 'runtimepath' until either
246	6	callable returns something but None, the exception is raised or there
247		are no longer paths. If stopped in case callable returned non-None,
248		vim.foreach_rtp function returns the value returned by callable.
249		"""
250		for path in self.request('vim_list_runtime_paths'):
251		try:
252		if cb(path) is not None:
253		break
254		except Exception:
		0 ignored issues – show Best Practice introduced 2015-12-02 06:47 UTC by Report Bug Copy Issue Report Catching very general exceptions such as `Exception` is usually not recommended. Generally, you would want to handle very specific errors in the exception handler. This ensure that you do not hide other types of errors which should be fixed. So, unless you specifically plan to handle any error, consider adding a more specific exception. Loading history...
255		break
256
257	6	def chdir(self, dir_path):
258		"""Run os.chdir, then all appropriate vim stuff."""
259		os_chdir(dir_path)
260		return self.request('vim_change_directory', dir_path)
261
262		def feedkeys(self, keys, options='', escape_csi=True):
263		"""Push `keys` to Nvim user input buffer.
264
265	6	Options can be a string with the following character flags:
266		- 'm': Remap keys. This is default.
267	6	- 'n': Do not remap keys.
268		- 't': Handle keys as if typed; otherwise they are handled as if coming
269		from a mapping. This matters for undo, opening folds, etc.
270		"""
271		return self.request('vim_feedkeys', keys, options, escape_csi)
272
273		def input(self, bytes):
		0 ignored issues – show Bug Best Practice introduced 2015-12-02 06:47 UTC by Report Bug Copy Issue Report This seems to re-define the built-in `bytes`. It is generally discouraged to redefine built-ins as this makes code very hard to read. Loading history...
274		"""Push `bytes` to Nvim low level input buffer.
275
276		Unlike `feedkeys()`, this uses the lowest level input buffer and the
277		call is not deferred. It returns the number of bytes actually
278		written(which can be less than what was requested if the buffer is
279		full).
280		"""
281		return self.request('vim_input', bytes)
282
283		def replace_termcodes(self, string, from_part=False, do_lt=True,
284	6	special=True):
285		r"""Replace any terminal code strings by byte sequences.
286
287		The returned sequences are Nvim's internal representation of keys,
288	6	for example:
289
290		<esc> -> '\x1b'
291		<cr> -> '\r'
292	6	<c-l> -> '\x0c'
293		<up> -> '\x80ku'
294
295		The returned sequences can be used as input to `feedkeys`.
296		"""
297		return self.request('vim_replace_termcodes', string,
298		from_part, do_lt, special)
299
300	2	def out_write(self, msg):
301		"""Print `msg` as a normal message."""
302		return self.request('vim_out_write', msg)
303
304		def err_write(self, msg, **kwargs):
305		"""Print `msg` as an error message."""
306	6	return self.request('vim_err_write', msg, **kwargs)
307
308	3	def quit(self, quit_command='qa!'):
309		"""Send a quit command to Nvim.
310	6
311		By default, the quit command is 'qa!' which will make Nvim quit without
312		saving anything.
313		"""
314		try:
315		self.command(quit_command)
316		except IOError:
		0 ignored issues – show Unused Code introduced 2015-12-02 06:47 UTC by Report Bug Copy Issue Report This except handler seems to be unused and could be removed. Except handlers which only contain `pass` and do not have an `else` clause can usually simply be removed: try: raises_exception() except: # Could be removed pass Loading history...
317		# sending a quit command will raise an IOError because the
318		# connection is closed before a response is received. Safe to
319		# ignore it.
320	6	pass
321
322	6	def new_highlight_source(self):
323	6	"""Return new src_id for use with Buffer.add_highlight."""
324	6	return self.current.buffer.add_highlight("", 0, src_id=0)
325
326		def async_call(self, fn, args, *kwargs):
327		"""Schedule `fn` to be called by the event loop soon.
328
329		This function is thread-safe, and is the only way code not
330		on the main thread could interact with nvim api objects.
331	6
332		This function can also be called in a synchronous
333		event handler, just before it returns, to defer execution
334	6	that shouldn't block neovim.
335		"""
336		call_point = ''.join(format_stack(None, 5)[:-1])
337
338		def handler():
339		try:
340		fn(args, *kwargs)
341		except Exception as err:
342		msg = ("error caught while executing async callback:\n"
343		"{0!r}\n{1}\n \nthe call was requested at\n{2}"
344		.format(err, format_exc_skip(1, 5), call_point))
345	6	self._err_cb(msg)
346		raise
347	6	self._session.threadsafe_call(handler)
348
349	6
350		class Buffers(object):
351	6
352		"""Remote NVim buffers.
353	6
354		Currently the interface for interacting with remote NVim buffers is the
355	6	`vim_get_buffers` msgpack-rpc function. Most methods fetch the list of
356	6	buffers from NVim.
357	6
358		Conforms to python-buffers.
359		"""
360	6
361		def __init__(self, nvim):
362	6	"""Initialize a Buffers object with Nvim object `nvim`."""
363		self._fetch_buffers = nvim.api.get_buffers
364	6
365		def __len__(self):
366	6	"""Return the count of buffers."""
367		return len(self._fetch_buffers())
368
369	6	def __getitem__(self, number):
370		"""Return the Buffer object matching buffer number `number`."""
371		for b in self._fetch_buffers():
372		if b.number == number:
373	6	return b
374	6	raise KeyError(number)
375
376		def __contains__(self, b):
377	6	"""Return whether Buffer `b` is a known valid buffer."""
378		return isinstance(b, Buffer) and b.valid
379
380		def __iter__(self):
381	6	"""Return an iterator over the list of buffers."""
382	6	return iter(self._fetch_buffers())
383	6
384
385	6	class CompatibilitySession(object):
386
387	6	"""Helper class for API compatibility."""
388
389	6	def __init__(self, nvim):
390		self.threadsafe_call = nvim.async_call
391	6
392
393	6	class Current(object):
394
395	6	"""Helper class for emulating vim.current from python-vim."""
396
397	6	def __init__(self, session):
398		self._session = session
399	6	self.range = None
400
401	6	@property
402		def line(self):
403	6	return self._session.request('vim_get_current_line')
404
405	6	@line.setter
406		def line(self, line):
407	6	return self._session.request('vim_set_current_line', line)
408
409	6	@property
410		def buffer(self):
411	6	return self._session.request('vim_get_current_buffer')
412
413	6	@buffer.setter
414		def buffer(self, buffer):
415	6	return self._session.request('vim_set_current_buffer', buffer)
416
417		@property
418	6	def window(self):
419		return self._session.request('vim_get_current_window')
420
421		@window.setter
422	6	def window(self, window):
423	6	return self._session.request('vim_set_current_window', window)
424
425	6	@property
426	6	def tabpage(self):
427		return self._session.request('vim_get_current_tabpage')
428
429	6	@tabpage.setter
430	6	def tabpage(self, tabpage):
431		return self._session.request('vim_set_current_tabpage', tabpage)
432
433
434		class Funcs(object):
435
436		"""Helper class for functional vimscript interface."""
437
438		def __init__(self, nvim):
439		self._nvim = nvim
440
441		def __getattr__(self, name):
442		return functools.partial(self._nvim.call, name)
443
444
445		class NvimError(Exception):
446		pass
447

neovim / python-client

Pull Request — master (#217)

Nvim.request() B

Complexity

Size

Duplication

Code Coverage

Importance

1. Missing Dependencies

2. Missing __init__.py files

Duplication Side-by-Side

Filter issues like

2. Missing init.py files