[ Web Proxy ]
URL:
Viewing: https://raw.githubusercontent.com/pixelneo/vim-python-docstring/hints/python/vimenv.py [Back]  [Original]

import vim
import abc


class Enviroment(abc.ABC):

    @property
    @abc.abstractmethod
    def plugin_root_dir(self):
        """ Return absolute path to directory one level above of directory
            containing python scripts.
        """

    @property
    @abc.abstractmethod
    def python_style(self):
        """ Returns string containing docstring style: google, numpy, etc.
            The style has to have corresponding template of name 
            -method.txt end -class.txt in folder 'styles'.
        """

    @property
    @abc.abstractmethod
    def python_indent(self):
        """ Returns indentation of python source (tab, 4 spaces, ...) """

    @property
    @abc.abstractmethod
    def current_line_nr(self):
        """ Returns number of the current line, indexed from 0. """

    @property
    @abc.abstractmethod
    def current_line(self):
        """ Returns current line. """

    @abc.abstractmethod
    def append_after_line(self, line_nr, text):
        """ Print to buffer

        Append `text` to buffer on line below `line_nr`.

        Args:
            line_nr: (int)
            text: (str)

        """

    @abc.abstractmethod
    def lines_following_cursor(self):
        """ Generator that iterates lines in buffer, starting from current line. """

    # #TODO will this work???
    # @abc.abstractmethod
    # def lines_till_end(self):
        # """ Returns all lines from the current one until the end. """


class VimEnviroment(Enviroment):

    def __init__(self):
        pass

    def _get_var(self, name):
        return vim.eval(name)

    @property
    def plugin_root_dir(self):
        return self._get_var('s:plugin_root_dir')

    @property
    def python_style(self):
        if not int(vim.eval('exists("g:python_style")')):
            return "google"
        else:
            return self._get_var('g:python_style')

    @property
    def python_indent(self):
        if not int(vim.eval('exists("g:python_indent")')):
            return "    "
        else:
            return self._get_var('g:python_indent')

    @property
    def current_line_nr(self):
        return vim.current.window.cursor[0] - 1

    @property
    def current_line(self):
        return vim.current.line

    def append_after_line(self, line_nr, text):
        line_nr += 1
        for line in reversed(text.split('\n')):
            vim.current.buffer.append(line, line_nr)

    def lines_following_cursor(self):
        import vim
        buffer = vim.current.buffer
        cursor_row = vim.current.window.cursor[0] - 1
        current_row = cursor_row
        while True:
            if current_row > len(vim.current.buffer) - 1:
                raise StopIteration('Buffer is out of lines.')
            yield current_row, buffer[current_row]
            current_row += 1

Web Proxy Viewer  |  New URL  |  Original Page