neovim.api.Nvim.next_message() - Code Metrics - Inspection of "Refactor: let Nvim be the session wrapper and simp..." - neovim/python-client - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#179)

by Björn

created 2016-03-20 11:27 UTC

neovim.api.Nvim.next_message() A

↳ Parent: neovim.api.Nvim

Complexity

Conditions

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	4
CRAP Score	2

Metric	Value
cc	2
dl	0
loc	5
ccs	4
cts	4
cp	1
crap	2
rs	9.4285

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

from traceback import format_exc, 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 (DecodeHook, Remote, RemoteApi,
                     RemoteMap, RemoteSequence, walk)
from .tabpage import Tabpage
from .window import Window
from ..compat import IS_PYTHON3


__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 thin 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_hook` instance method and passing a SessionHook instance. This can
    be useful to have 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 = DecodeHook().walk(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 extisting instance."""
        return cls(nvim.session, nvim.channel_id, nvim.metadata,
                   nvim.types, nvim._decodehook, 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,
                 decodehook=None, 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 = RemoteSequence(self, 'vim_get_buffers')
        self.windows = RemoteSequence(self, 'vim_get_windows')
        self.tabpages = RemoteSequence(self, 'vim_get_tabpages')
        self.current = Current(self)
        self.funcs = Funcs(self)
        self.error = NvimError
        self._decodehook = decodehook
        self._err_cb = err_cb

    def _from_nvim(self, obj):
        if type(obj) is ExtType:
            cls = self.types[obj.code]
            return cls(self, (obj.code, obj.data))
        if self._decodehook is not None:
            obj = self._decodehook.decode_if_bytes(obj)
        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):
        """Wrapper for Session.request."""
        args = walk(self._to_nvim, args)
        res = self._session.request(name, *args, **kwargs)
        return walk(self._from_nvim, res)

    def next_message(self):
        """Wrapper for Session.next_message."""
        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):
        """Wrapper for Session.run."""
        def filter_request_cb(name, args):
            args = walk(self._from_nvim, args)
            result = request_cb(self._from_nvim(name), args)
            return walk(self._to_nvim, result)

        def filter_notification_cb(name, args):
            notification_cb(self._from_nvim(name), walk(self._from_nvim, args))

        if err_cb is None:
            err_cb = sys.stderr.write
        self._err_cb = err_cb

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

    def stop_loop(self):
        """Wrapper for Session.stop."""
        self._session.stop()

    def with_decodehook(self, hook):
        """Initialize a new Nvim instance."""
        return Nvim(self.session, self.channel_id,
                    self.metadata, self.types, hook, self._err_cb)

    @property
    def session(self):
        """Return the Session or SessionFilter for a Nvim instance."""
        return self._session

    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, async=False):
        """Execute a single ex command."""
        return self.request('vim_command', string, async=async)

    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, async=False):
        """Evaluate a vimscript expression."""
        return self.request('vim_eval', string, async=async)

    def call(self, name, *args, **kwargs):
        """Call a vimscript function."""
        for k in kwargs:
            if k != "async":
                raise TypeError(
                    "call() got an unexpected keyword argument '{}'".format(k))
        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, async=False):
        """Print `msg` as an error message."""
        return self.request('vim_err_write', msg, async=async)

    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"
                       "{!r}\n{}\n \nthe call was requested at\n{}"
                       .format(err, format_exc(5), call_point))
                self._err_cb(msg)
                raise
        self._session.threadsafe_call(handler)


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 (#179)

neovim.api.Nvim.next_message() A

Complexity

Size

Duplication

Code Coverage

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_exc, 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 (DecodeHook, Remote, RemoteApi,
12		RemoteMap, RemoteSequence, walk)
13	6	from .tabpage import Tabpage
14	6	from .window import Window
15	6	from ..compat import IS_PYTHON3
16
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 thin 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_hook` instance method and passing a SessionHook instance. This can
37		be useful to have multiple `Nvim` objects that behave differently without
38		one affecting the other.
39		"""
40
41	6	@classmethod
42		def from_session(cls, session):
43		"""Create a new Nvim instance for a Session instance.
44
45		This method must be called to create the first Nvim instance, since it
46		queries Nvim metadata for type information and sets a SessionHook for
47		creating specialized objects from Nvim remote handles.
48		"""
49	6	session.error_wrapper = lambda e: NvimError(e[1])
50	6	channel_id, metadata = session.request(b'vim_get_api_info')
51
52	6	if IS_PYTHON3:
53		# decode all metadata strings for python3
54	6	metadata = DecodeHook().walk(metadata)
55
56	6	types = {
57		metadata['types']['Buffer']['id']: Buffer,
58		metadata['types']['Window']['id']: Window,
59		metadata['types']['Tabpage']['id']: Tabpage,
60		}
61
62	6	return cls(session, channel_id, metadata, types)
63
64	6	@classmethod
65		def from_nvim(cls, nvim):
66		"""Create a new Nvim instance from an extisting instance."""
67		return cls(nvim.session, nvim.channel_id, nvim.metadata,
68		nvim.types, nvim._decodehook, nvim._err_cb)
		0 ignored issues – show Coding Style Best Practice introduced 2016-03-20 11:50 UTC by Report Bug Copy Issue Report It seems like `_decodehook` 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...
69
70	6	def __init__(self, session, channel_id, metadata, types,
71		decodehook=None, err_cb=None):
72		"""Initialize a new Nvim instance. This method is module-private."""
73	6	self._session = session
74	6	self.channel_id = channel_id
75	6	self.metadata = metadata
76	6	self.types = types
77	6	self.api = RemoteApi(self, 'vim_')
78	6	self.vars = RemoteMap(self, 'vim_get_var', 'vim_set_var')
79	6	self.vvars = RemoteMap(self, 'vim_get_vvar', None)
80	6	self.options = RemoteMap(self, 'vim_get_option', 'vim_set_option')
81	6	self.buffers = RemoteSequence(self, 'vim_get_buffers')
82	6	self.windows = RemoteSequence(self, 'vim_get_windows')
83	6	self.tabpages = RemoteSequence(self, 'vim_get_tabpages')
84	6	self.current = Current(self)
85	6	self.funcs = Funcs(self)
86	6	self.error = NvimError
87	6	self._decodehook = decodehook
88	6	self._err_cb = err_cb
89
90	6	def _from_nvim(self, obj):
91	6	if type(obj) is ExtType:
92	6	cls = self.types[obj.code]
93	6	return cls(self, (obj.code, obj.data))
94	6	if self._decodehook is not None:
95	3	obj = self._decodehook.decode_if_bytes(obj)
96	6	return obj
97
98	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...
99	6	if isinstance(obj, Remote):
100	6	return ExtType(*obj.code_data)
101	6	return obj
102
103	6	def request(self, name, args, *kwargs):
104		"""Wrapper for Session.request."""
105	6	args = walk(self._to_nvim, args)
106	6	res = self._session.request(name, args, *kwargs)
107	6	return walk(self._from_nvim, res)
108
109	6	def next_message(self):
110		"""Wrapper for Session.next_message."""
111	6	msg = self._session.next_message()
112	6	if msg:
113	6	return walk(self._from_nvim, msg)
114
115	6	def run_loop(self, request_cb, notification_cb,
116		setup_cb=None, err_cb=None):
117		"""Wrapper for Session.run."""
118	6	def filter_request_cb(name, args):
119	6	args = walk(self._from_nvim, args)
120	6	result = request_cb(self._from_nvim(name), args)
121	6	return walk(self._to_nvim, result)
122
123	6	def filter_notification_cb(name, args):
124		notification_cb(self._from_nvim(name), walk(self._from_nvim, args))
125
126	6	if err_cb is None:
127	6	err_cb = sys.stderr.write
128	6	self._err_cb = err_cb
129
130	6	self._session.run(filter_request_cb, filter_notification_cb, setup_cb)
131
132	6	def stop_loop(self):
133		"""Wrapper for Session.stop."""
134	6	self._session.stop()
135
136	6	def with_decodehook(self, hook):
137		"""Initialize a new Nvim instance."""
138	3	return Nvim(self.session, self.channel_id,
139		self.metadata, self.types, hook, self._err_cb)
140
141	6	@property
142		def session(self):
143		"""Return the Session or SessionFilter for a Nvim instance."""
144	5	return self._session
145
146	6	def ui_attach(self, width, height, rgb):
147		"""Register as a remote UI.
148
149		After this method is called, the client will receive redraw
150		notifications.
151		"""
152		return self.request('ui_attach', width, height, rgb)
153
154	6	def ui_detach(self):
155		"""Unregister as a remote UI."""
156		return self.request('ui_detach')
157
158	6	def ui_try_resize(self, width, height):
159		"""Notify nvim that the client window has resized.
160
161		If possible, nvim will send a redraw request to resize.
162		"""
163		return self.request('ui_try_resize', width, height)
164
165	6	def subscribe(self, event):
166		"""Subscribe to a Nvim event."""
167	6	return self.request('vim_subscribe', event)
168
169	6	def unsubscribe(self, event):
170		"""Unsubscribe to a Nvim event."""
171	6	return self.request('vim_unsubscribe', event)
172
173	6	def command(self, string, async=False):
174		"""Execute a single ex command."""
175	6	return self.request('vim_command', string, async=async)
176
177	6	def command_output(self, string):
178		"""Execute a single ex command and return the output."""
179		return self.request('vim_command_output', string)
180
181	6	def eval(self, string, async=False):
182		"""Evaluate a vimscript expression."""
183	6	return self.request('vim_eval', string, async=async)
184
185	6	def call(self, name, args, *kwargs):
186		"""Call a vimscript function."""
187	6	for k in kwargs:
188	6	if k != "async":
189		raise TypeError(
190		"call() got an unexpected keyword argument '{}'".format(k))
191	6	return self.request('vim_call_function', name, args, **kwargs)
192
193	6	def strwidth(self, string):
194		"""Return the number of display cells `string` occupies.
195
196		Tab is counted as one cell.
197		"""
198	6	return self.request('vim_strwidth', string)
199
200	6	def list_runtime_paths(self):
201		"""Return a list of paths contained in the 'runtimepath' option."""
202		return self.request('vim_list_runtime_paths')
203
204	6	def foreach_rtp(self, cb):
205		"""Invoke `cb` for each path in 'runtimepath'.
206
207		Call the given callable for each path in 'runtimepath' until either
208		callable returns something but None, the exception is raised or there
209		are no longer paths. If stopped in case callable returned non-None,
210		vim.foreach_rtp function returns the value returned by callable.
211		"""
212		for path in self.request('vim_list_runtime_paths'):
213		try:
214		if cb(path) is not None:
215		break
216		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...
217		break
218
219	6	def chdir(self, dir_path):
220		"""Run os.chdir, then all appropriate vim stuff."""
221	6	os_chdir(dir_path)
222	6	return self.request('vim_change_directory', dir_path)
223
224	6	def feedkeys(self, keys, options='', escape_csi=True):
225		"""Push `keys` to Nvim user input buffer.
226
227		Options can be a string with the following character flags:
228		- 'm': Remap keys. This is default.
229		- 'n': Do not remap keys.
230		- 't': Handle keys as if typed; otherwise they are handled as if coming
231		from a mapping. This matters for undo, opening folds, etc.
232		"""
233		return self.request('vim_feedkeys', keys, options, escape_csi)
234
235	6	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...
236		"""Push `bytes` to Nvim low level input buffer.
237
238		Unlike `feedkeys()`, this uses the lowest level input buffer and the
239		call is not deferred. It returns the number of bytes actually
240		written(which can be less than what was requested if the buffer is
241		full).
242		"""
243	6	return self.request('vim_input', bytes)
244
245	6	def replace_termcodes(self, string, from_part=False, do_lt=True,
246		special=True):
247		r"""Replace any terminal code strings by byte sequences.
248
249		The returned sequences are Nvim's internal representation of keys,
250		for example:
251
252		<esc> -> '\x1b'
253		<cr> -> '\r'
254		<c-l> -> '\x0c'
255		<up> -> '\x80ku'
256
257		The returned sequences can be used as input to `feedkeys`.
258		"""
259		return self.request('vim_replace_termcodes', string,
260		from_part, do_lt, special)
261
262	6	def out_write(self, msg):
263		"""Print `msg` as a normal message."""
264		return self.request('vim_out_write', msg)
265
266	6	def err_write(self, msg, async=False):
267		"""Print `msg` as an error message."""
268		return self.request('vim_err_write', msg, async=async)
269
270	6	def quit(self, quit_command='qa!'):
271		"""Send a quit command to Nvim.
272
273		By default, the quit command is 'qa!' which will make Nvim quit without
274		saving anything.
275		"""
276		try:
277		self.command(quit_command)
278		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...
279		# sending a quit command will raise an IOError because the
280		# connection is closed before a response is received. Safe to
281		# ignore it.
282		pass
283
284	6	def new_highlight_source(self):
285		"""Return new src_id for use with Buffer.add_highlight."""
286		return self.current.buffer.add_highlight("", 0, src_id=0)
287
288	6	def async_call(self, fn, args, *kwargs):
289		"""Schedule `fn` to be called by the event loop soon.
290
291		This function is thread-safe, and is the only way code not
292		on the main thread could interact with nvim api objects.
293
294		This function can also be called in a synchronous
295		event handler, just before it returns, to defer execution
296		that shouldn't block neovim.
297		"""
298	6	call_point = ''.join(format_stack(None, 5)[:-1])
299
300	6	def handler():
301	6	try:
302	6	fn(args, *kwargs)
303		except Exception as err:
304		msg = ("error caught while executing async callback:\n"
305		"{!r}\n{}\n \nthe call was requested at\n{}"
306		.format(err, format_exc(5), call_point))
307	3	self._err_cb(msg)
308	4	raise
309	6	self._session.threadsafe_call(handler)
310
311
312	6	class Current(object):
313
314		"""Helper class for emulating vim.current from python-vim."""
315
316	6	def __init__(self, session):
317	6	self._session = session
318	6	self.range = None
319
320	6	@property
321		def line(self):
322	6	return self._session.request('vim_get_current_line')
323
324	6	@line.setter
325		def line(self, line):
326	6	return self._session.request('vim_set_current_line', line)
327
328	6	@property
329		def buffer(self):
330	6	return self._session.request('vim_get_current_buffer')
331
332	6	@buffer.setter
333		def buffer(self, buffer):
334	6	return self._session.request('vim_set_current_buffer', buffer)
335
336	6	@property
337		def window(self):
338	6	return self._session.request('vim_get_current_window')
339
340	6	@window.setter
341		def window(self, window):
342	6	return self._session.request('vim_set_current_window', window)
343
344	6	@property
345		def tabpage(self):
346	6	return self._session.request('vim_get_current_tabpage')
347
348	6	@tabpage.setter
349		def tabpage(self, tabpage):
350	6	return self._session.request('vim_set_current_tabpage', tabpage)
351
352
353	6	class Funcs(object):
354
355		"""Helper class for functional vimscript interface."""
356
357	6	def __init__(self, nvim):
358	6	self._nvim = nvim
359
360	6	def __getattr__(self, name):
361	6	return functools.partial(self._nvim.call, name)
362
363
364	6	class NvimError(Exception):
365		pass
366

neovim / python-client

Pull Request — master (#179)

neovim.api.Nvim.next_message() A

Complexity

Size

Duplication

Code Coverage

1. Missing Dependencies

2. Missing __init__.py files

Duplication Side-by-Side

Filter issues like

2. Missing init.py files