Module vpe.channels

Development of channel support.

JSChannel

class vpe.channels.JSChannel(...)

JSChannel(
    net_address: str,
    drop: Optional[str] = None,
    noblock: Optional[bool] = None,
    waittime: Optional[int] = None,
    timeout_ms: Optional[int] = None)

Pythonic wrapper around a Vim channel in javascript mode.

JsonChannel

class vpe.channels.JsonChannel(...)

JsonChannel(
    net_address: str,
    drop: Optional[str] = None,
    noblock: Optional[bool] = None,
    waittime: Optional[int] = None,
    timeout_ms: Optional[int] = None)

Pythonic wrapper around a Vim channel in json mode.

NLChannel

class vpe.channels.NLChannel(...)

NLChannel(
    net_address: str,
    drop: Optional[str] = None,
    noblock: Optional[bool] = None,
    waittime: Optional[int] = None,
    timeout_ms: Optional[int] = None)

Pythonic wrapper for a newline based channel.

RawChannel

class vpe.channels.RawChannel(...)

RawChannel(
    net_address: str,
    drop: Optional[str] = None,
    noblock: Optional[bool] = None,
    waittime: Optional[int] = None,
    timeout_ms: Optional[int] = None)

Pythonic wrapper for a raw channel.

VimChannel

class vpe.channels.VimChannel(varname: str)

Simple proxy for a Channel.

This manages keeping the underlying Vim channel object alive, by storing it in a global Vim variable.

Parameters

varname

The name of the a vim variable currently referencing the Channel.

Attributes

varname

The name of a Vim variable holding a reference to the underlying Vim channel object. This is provided for debugging purposes.

Properties

property chid

The ID for this channel.

property closed

True of the channel could not be opened or has been closed.

property info

Get the information for a channel.

Methods

close()

Mark as closed and release the underlying reference variable.