Buffers

Complexity

Total Complexity

7

Size/Duplication

Total Lines	31
Duplicated Lines	0 %

Test Coverage

Coverage

92.86%

Importance

Changes	1
Bugs	0	Features	0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	__contains__()	0	3	1
A	__getitem__()	0	6	3
A	__len__()	0	3	1
A	__init__()	0	3	1
A	__iter__()	0	3	1

"""API for working with NVim buffers.

Conforms to python-buffers, which reads:

  vim.buffers                        *python-buffers*
    A mapping object providing access to the list of vim buffers.  The
    object supports the following operations: >
        :py b = vim.buffers[i]    # Indexing (read-only)
        :py b in vim.buffers    # Membership test
        :py n = len(vim.buffers)    # Number of elements
        :py for b in vim.buffers:    # Iterating over buffer list

The key for indexing into vim.buffers[] is the buffer number as described in
*python-buffer*.
"""

import functools

__all__ = ('Buffers')


class Buffers(object):

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

    def __init__(self, nvim):
        """Initialize a Buffers object with Nvim object `nvim`."""
        self._fetch_buffers = functools.partial(nvim.request, 'vim_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("No buffers match buffer number {}".format(number))

    def __contains__(self, b):
        """Return whether Buffer `b` is a valid buffer known to the remote end."""
        return b in self._fetch_buffers()

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