Nvim.close() - Code Metrics - Inspection of "[WIP] closing the event loop" - neovim/python-client - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#303)

by Björn

created 2018-02-28 16:40 UTC

Nvim.close() A

↳ Parent: Nvim

Complexity

Conditions

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	1

Importance

Changes

Metric	Value
cc	1
dl	0
loc	3
ccs	2
cts	2
cp	1
crap	1
rs	10
c	0
b	0
f	0

"""Main Nvim interface."""
import os
import sys
from functools import partial
from contextlib import closing

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 Version, 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
        version = metadata.get("version", {"api_level": 0})
        self.version = Version(**version)
        self.types = types
        self.api = RemoteApi(self, 'nvim_')
        self.vars = RemoteMap(self, 'nvim_get_var', 'nvim_set_var')
        self.vvars = RemoteMap(self, 'nvim_get_vvar', None)
        self.options = RemoteMap(self, 'nvim_get_option', 'nvim_set_option')
        self.buffers = Buffers(self)
        self.windows = RemoteSequence(self, 'nvim_list_wins')
        self.tabpages = RemoteSequence(self, 'nvim_list_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('nvim_err_write', 'ERROR\n', async=True)
            vim.request('nvim_buf_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)))
                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)))
                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 close(self):
        """Close the nvim session and release its resources."""
        self._session.close()

    def __enter__(self):
        return self

    def __exit__(self, *exc_info):
        self.close()

    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('nvim_subscribe', event)

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

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

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

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

    def call(self, name, *args, **kwargs):
        """Call a vimscript function."""
        return self.request('nvim_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('nvim_strwidth', string)

    def list_runtime_paths(self):
        """Return a list of paths contained in the 'runtimepath' option."""
        return self.request('nvim_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('nvim_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('nvim_set_current_dir', 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('nvim_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('nvim_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('nvim_replace_termcodes', string,
                            from_part, do_lt, special)

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

    def err_write(self, msg, **kwargs):
        """Print `msg` as an error message."""
        return self.request('nvim_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"
                       "{!r}\n{}\n \nthe call was requested at\n{}"
                       .format(err, format_exc_skip(1), 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
    `nvim_list_bufs` 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.list_bufs

    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('nvim_get_current_line')

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

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

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

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

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

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

    @tabpage.setter
    def tabpage(self, tabpage):
        return self._session.request('nvim_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 partial(self._nvim.call, name)


class NvimError(Exception):
    pass


Pull Request — master (#303)

Nvim.close() A

Complexity

Size

Duplication

Code Coverage

Importance

1. Missing Dependencies

2. Missing init.py files

1		"""Main Nvim interface."""
2	5	import os
3	5	import sys
4	5	from functools import partial
5		from contextlib import closing
		0 ignored issues – show Unused Code introduced 2018-02-28 17:05 UTC by Report Bug Copy Issue Report Unused closing imported from contextlib Loading history...
6	5	from traceback import format_stack
7
8	5	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	5	from .buffer import Buffer
11	5	from .common import (Remote, RemoteApi, RemoteMap, RemoteSequence,
12		decode_if_bytes, walk)
13	5	from .tabpage import Tabpage
14	5	from .window import Window
15	5	from ..compat import IS_PYTHON3
16	5	from ..util import Version, format_exc_skip
17
18	5	__all__ = ('Nvim')
19
20
21	5	os_chdir = os.chdir
22
23
24	5	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	5	@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	5	session.error_wrapper = lambda e: NvimError(e[1])
51	5	channel_id, metadata = session.request(b'vim_get_api_info')
52
53	5	if IS_PYTHON3:
54		# decode all metadata strings for python3
55	5	metadata = walk(decode_if_bytes, metadata)
56
57	5	types = {
58		metadata['types']['Buffer']['id']: Buffer,
59		metadata['types']['Window']['id']: Window,
60		metadata['types']['Tabpage']['id']: Tabpage,
61		}
62
63	5	return cls(session, channel_id, metadata, types)
64
65	5	@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	5	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	5	self._session = session
75	5	self.channel_id = channel_id
76	5	self.metadata = metadata
77	5	version = metadata.get("version", {"api_level": 0})
78	5	self.version = Version(**version)
79	5	self.types = types
80	5	self.api = RemoteApi(self, 'nvim_')
81	5	self.vars = RemoteMap(self, 'nvim_get_var', 'nvim_set_var')
82	5	self.vvars = RemoteMap(self, 'nvim_get_vvar', None)
83	5	self.options = RemoteMap(self, 'nvim_get_option', 'nvim_set_option')
84	5	self.buffers = Buffers(self)
85	5	self.windows = RemoteSequence(self, 'nvim_list_wins')
86	5	self.tabpages = RemoteSequence(self, 'nvim_list_tabpages')
87	5	self.current = Current(self)
88	5	self.session = CompatibilitySession(self)
89	5	self.funcs = Funcs(self)
90	5	self.error = NvimError
91	5	self._decode = decode
92	5	self._err_cb = err_cb
93
94	5	def _from_nvim(self, obj, decode=None):
95	5	if decode is None:
96	5	decode = self._decode
97	5	if type(obj) is ExtType:
98	5	cls = self.types[obj.code]
99	5	return cls(self, (obj.code, obj.data))
100	5	if decode:
101	3	obj = decode_if_bytes(obj, decode)
102	5	return obj
103
104	5	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...
105	5	if isinstance(obj, Remote):
106	5	return ExtType(*obj.code_data)
107	5	return obj
108
109	5	def request(self, name, args, *kwargs):
110		r"""Send an API request or notification to nvim.
111
112		It is rarely needed to call this function directly, as most API
113		functions have python wrapper functions. The `api` object can
114		be also be used to call API functions as methods:
115
116		vim.api.err_write('ERROR\n', async=True)
117		vim.current.buffer.api.get_mark('.')
118
119		is equivalent to
120
121		vim.request('nvim_err_write', 'ERROR\n', async=True)
122		vim.request('nvim_buf_get_mark', vim.current.buffer, '.')
123
124
125		Normally a blocking request will be sent. If the `async` flag is
126		present and True, a asynchronous notification is sent instead. This
127		will never block, and the return value or error is ignored.
128		"""
129	5	decode = kwargs.pop('decode', self._decode)
130	5	args = walk(self._to_nvim, args)
131	5	res = self._session.request(name, args, *kwargs)
132	5	return walk(self._from_nvim, res, decode=decode)
133
134	5	def next_message(self):
135		"""Block until a message(request or notification) is available.
136
137		If any messages were previously enqueued, return the first in queue.
138		If not, run the event loop until one is received.
139		"""
140	5	msg = self._session.next_message()
141	5	if msg:
142	5	return walk(self._from_nvim, msg)
143
144	5	def run_loop(self, request_cb, notification_cb,
145		setup_cb=None, err_cb=None):
146		"""Run the event loop to receive requests and notifications from Nvim.
147
148		This should not be called from a plugin running in the host, which
149		already runs the loop and dispatches events to plugins.
150		"""
151	5	if err_cb is None:
152	5	err_cb = sys.stderr.write
153	5	self._err_cb = err_cb
154
155	5	def filter_request_cb(name, args):
156	5	name = self._from_nvim(name)
157	5	args = walk(self._from_nvim, args)
158	5	try:
159	5	result = request_cb(name, args)
160		except Exception:
161		msg = ("error caught in request handler '{} {}'\n{}\n\n"
162		.format(name, args, format_exc_skip(1)))
163		self._err_cb(msg)
164		raise
165	5	return walk(self._to_nvim, result)
166
167	5	def filter_notification_cb(name, args):
168		name = self._from_nvim(name)
169		args = walk(self._from_nvim, args)
170		try:
171		notification_cb(name, args)
172		except Exception:
173		msg = ("error caught in notification handler '{} {}'\n{}\n\n"
174		.format(name, args, format_exc_skip(1)))
175		self._err_cb(msg)
176		raise
177
178	5	self._session.run(filter_request_cb, filter_notification_cb, setup_cb)
179
180	5	def stop_loop(self):
181		"""Stop the event loop being started with `run_loop`."""
182	5	self._session.stop()
183
184	5	def close(self):
185		"""Close the nvim session and release its resources."""
186	5	self._session.close()
187
188		def __enter__(self):
189	5	return self
190
191		def __exit__(self, *exc_info):
192		self.close()
193
194		def with_decode(self, decode=True):
195		"""Initialize a new Nvim instance."""
196		return Nvim(self._session, self.channel_id,
197	5	self.metadata, self.types, decode, self._err_cb)
198
199		def ui_attach(self, width, height, rgb):
200		"""Register as a remote UI.
201	5
202		After this method is called, the client will receive redraw
203		notifications.
204		"""
205		return self.request('ui_attach', width, height, rgb)
206
207		def ui_detach(self):
208	5	"""Unregister as a remote UI."""
209		return self.request('ui_detach')
210	5
211		def ui_try_resize(self, width, height):
212	5	"""Notify nvim that the client window has resized.
213
214	5	If possible, nvim will send a redraw request to resize.
215		"""
216	5	return self.request('ui_try_resize', width, height)
217
218	5	def subscribe(self, event):
219		"""Subscribe to a Nvim event."""
220	5	return self.request('nvim_subscribe', event)
221
222		def unsubscribe(self, event):
223		"""Unsubscribe to a Nvim event."""
224	5	return self.request('nvim_unsubscribe', event)
225
226	5	def command(self, string, **kwargs):
227		"""Execute a single ex command."""
228	5	return self.request('nvim_command', string, **kwargs)
229
230	5	def command_output(self, string):
231		"""Execute a single ex command and return the output."""
232	5	return self.request('nvim_command_output', string)
233
234		def eval(self, string, **kwargs):
235		"""Evaluate a vimscript expression."""
236		return self.request('nvim_eval', string, **kwargs)
237	5
238		def call(self, name, args, *kwargs):
239	5	"""Call a vimscript function."""
240		return self.request('nvim_call_function', name, args, **kwargs)
241
242		def strwidth(self, string):
243	5	"""Return the number of display cells `string` occupies.
244
245		Tab is counted as one cell.
246		"""
247		return self.request('nvim_strwidth', string)
248
249		def list_runtime_paths(self):
250		"""Return a list of paths contained in the 'runtimepath' option."""
251		return self.request('nvim_list_runtime_paths')
252
253		def foreach_rtp(self, cb):
254		"""Invoke `cb` for each path in 'runtimepath'.
255
256		Call the given callable for each path in 'runtimepath' until either
257		callable returns something but None, the exception is raised or there
258	5	are no longer paths. If stopped in case callable returned non-None,
259		vim.foreach_rtp function returns the value returned by callable.
260	5	"""
261	5	for path in self.request('nvim_list_runtime_paths'):
262		try:
263	5	if cb(path) is not None:
264		break
265		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...
266		break
267
268		def chdir(self, dir_path):
269		"""Run os.chdir, then all appropriate vim stuff."""
270		os_chdir(dir_path)
271		return self.request('nvim_set_current_dir', dir_path)
272
273		def feedkeys(self, keys, options='', escape_csi=True):
274	5	"""Push `keys` to Nvim user input buffer.
275
276		Options can be a string with the following character flags:
277		- 'm': Remap keys. This is default.
278		- 'n': Do not remap keys.
279		- 't': Handle keys as if typed; otherwise they are handled as if coming
280		from a mapping. This matters for undo, opening folds, etc.
281		"""
282	5	return self.request('nvim_feedkeys', keys, options, escape_csi)
283
284	5	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...
285		"""Push `bytes` to Nvim low level input buffer.
286
287		Unlike `feedkeys()`, this uses the lowest level input buffer and the
288		call is not deferred. It returns the number of bytes actually
289		written(which can be less than what was requested if the buffer is
290		full).
291		"""
292		return self.request('nvim_input', bytes)
293
294		def replace_termcodes(self, string, from_part=False, do_lt=True,
295		special=True):
296		r"""Replace any terminal code strings by byte sequences.
297
298		The returned sequences are Nvim's internal representation of keys,
299		for example:
300
301	5	<esc> -> '\x1b'
302		<cr> -> '\r'
303		<c-l> -> '\x0c'
304		<up> -> '\x80ku'
305	5
306		The returned sequences can be used as input to `feedkeys`.
307	2	"""
308		return self.request('nvim_replace_termcodes', string,
309	5	from_part, do_lt, special)
310
311		def out_write(self, msg, **kwargs):
312		"""Print `msg` as a normal message."""
313		return self.request('nvim_out_write', msg, **kwargs)
314
315		def err_write(self, msg, **kwargs):
316		"""Print `msg` as an error message."""
317		return self.request('nvim_err_write', msg, **kwargs)
318
319		def quit(self, quit_command='qa!'):
320		"""Send a quit command to Nvim.
321
322		By default, the quit command is 'qa!' which will make Nvim quit without
323	5	saving anything.
324		"""
325		try:
326		self.command(quit_command)
327	5	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...
328		# sending a quit command will raise an IOError because the
329		# connection is closed before a response is received. Safe to
330		# ignore it.
331		pass
332
333		def new_highlight_source(self):
334		"""Return new src_id for use with Buffer.add_highlight."""
335		return self.current.buffer.add_highlight("", 0, src_id=0)
336
337	5	def async_call(self, fn, args, *kwargs):
338		"""Schedule `fn` to be called by the event loop soon.
339	5
340	5	This function is thread-safe, and is the only way code not
341	5	on the main thread could interact with nvim api objects.
342
343	1	This function can also be called in a synchronous
344		event handler, just before it returns, to defer execution
345		that shouldn't block neovim.
346	1	"""
347		call_point = ''.join(format_stack(None, 5)[:-1])
348	5
349		def handler():
350		try:
351	5	fn(args, *kwargs)
352		except Exception as err:
353		msg = ("error caught while executing async callback:\n"
354		"{!r}\n{}\n \nthe call was requested at\n{}"
355		.format(err, format_exc_skip(1), call_point))
356		self._err_cb(msg)
357		raise
358		self._session.threadsafe_call(handler)
359
360
361		class Buffers(object):
362	5
363		"""Remote NVim buffers.
364	5
365		Currently the interface for interacting with remote NVim buffers is the
366	5	`nvim_list_bufs` msgpack-rpc function. Most methods fetch the list of
367		buffers from NVim.
368	5
369		Conforms to python-buffers.
370	5	"""
371
372	5	def __init__(self, nvim):
373	5	"""Initialize a Buffers object with Nvim object `nvim`."""
374	5	self._fetch_buffers = nvim.api.list_bufs
375
376		def __len__(self):
377	5	"""Return the count of buffers."""
378		return len(self._fetch_buffers())
379	5
380		def __getitem__(self, number):
381	5	"""Return the Buffer object matching buffer number `number`."""
382		for b in self._fetch_buffers():
383	5	if b.number == number:
384		return b
385		raise KeyError(number)
386	5
387		def __contains__(self, b):
388		"""Return whether Buffer `b` is a known valid buffer."""
389		return isinstance(b, Buffer) and b.valid
390	5
391	5	def __iter__(self):
392		"""Return an iterator over the list of buffers."""
393		return iter(self._fetch_buffers())
394	5
395
396		class CompatibilitySession(object):
397
398	5	"""Helper class for API compatibility."""
399	5
400	5	def __init__(self, nvim):
401		self.threadsafe_call = nvim.async_call
402	5
403
404	5	class Current(object):
405
406	5	"""Helper class for emulating vim.current from python-vim."""
407
408	5	def __init__(self, session):
409		self._session = session
410	5	self.range = None
411
412	5	@property
413		def line(self):
414	5	return self._session.request('nvim_get_current_line')
415
416	5	@line.setter
417		def line(self, line):
418	5	return self._session.request('nvim_set_current_line', line)
419
420	5	@property
421		def buffer(self):
422	5	return self._session.request('nvim_get_current_buf')
423
424	5	@buffer.setter
425		def buffer(self, buffer):
426	5	return self._session.request('nvim_set_current_buf', buffer)
427
428	5	@property
429		def window(self):
430	5	return self._session.request('nvim_get_current_win')
431
432	5	@window.setter
433		def window(self, window):
434		return self._session.request('nvim_set_current_win', window)
435	5
436		@property
437		def tabpage(self):
438		return self._session.request('nvim_get_current_tabpage')
439	5
440	5	@tabpage.setter
441		def tabpage(self, tabpage):
442	5	return self._session.request('nvim_set_current_tabpage', tabpage)
443	5
444
445		class Funcs(object):
446	5
447	5	"""Helper class for functional vimscript interface."""
448
449		def __init__(self, nvim):
450		self._nvim = nvim
451
452		def __getattr__(self, name):
453		return partial(self._nvim.call, name)
454
455
456		class NvimError(Exception):
457		pass
458

neovim / python-client

Pull Request — master (#303)

Nvim.close() A

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