Text API

API for working with the Text type.

Import this module like this:

from sympathy.api import text

Class text.File

class sympathy.api.text.File(filename: Optional[str] = None, mode: str = 'r', **kwargs)

A Text type containing arbitrary text, be it Hamlet or some json encoded data structure.

Any node port with the Text type will produce an object of this kind.

get()

Return text data.

classmethod icon()

Return full path to svg icon.

names(kind=None, fields=None, **kwargs)

Return a formatted list with a name and type of the data. columns.

set(text_data)

Set text data.

source(other, shallow=False)

Copy the contents from other text.File. Equivalent to update().

update(other)

Copy the contents from other text.File. Equivalent to source().

classmethod viewer()

Return viewer class, which must be a subclass of sympathy.api.typeutil.ViewerBase