CstNode

class CstNode

Description

A CST node

Inheritance:

• CstNode

Members defined in CstNode (15 members)

	descendant_count	R	Get the node’s number of descendants, including one for the node itself.
	end_byte	R	Get the node’s end byte.
	end_point	R	Get the node’s end position in terms of rows and columns (Utf-8 based).
	has_error	R	Check if the node is a syntax error or contains any syntax errors.
	id	R	Get a numeric id for this node that is unique.
	is_error	R	Check if the node is a syntax error.
	is_extra	R	Check if the node is extra.
	is_missing	R	Check if the node is missing.
	is_named	R	Check if the node is named.
	start_byte	R	Get the node’s start byte.
	start_point	R	Get the node’s start position in terms of rows and columns (Utf-8 based).
	string	R	Get an S-expression representing the node as a string.
	symbol	R	Get the node’s type as a numerical id.
	type	R	Get the node’s type as a string.
	text		Get the node’s source text.

Attributes

property descendant_count: int

Get the node’s number of descendants, including one for the node itself.

property end_byte: int

Get the node’s end byte.

property end_point: syside.PositionUtf8

Get the node’s end position in terms of rows and columns (Utf-8 based).

property has_error: bool

Check if the node is a syntax error or contains any syntax errors.

property id: int

Get a numeric id for this node that is unique.

Within a given syntax tree, no two nodes have the same id.

property is_error: bool

Check if the node is a syntax error.

property is_extra: bool

Check if the node is extra.

Extra nodes represent things like comments, which are not required by the grammar, but can appear anywhere.

property is_missing: bool

Check if the node is missing.

Missing nodes are inserted by the parser in order to recover from certain kinds of syntax errors.

property is_named: bool

Check if the node is named.

Named nodes correspond to named rules in the grammar, whereas anonymous nodes correspond to string literals in the grammar.

property start_byte: int

Get the node’s start byte.

property start_point: syside.PositionUtf8

Get the node’s start position in terms of rows and columns (Utf-8 based).

property string: str

Get an S-expression representing the node as a string.

property symbol: syside.Symbol

Get the node’s type as a numerical id.

property type: str

Get the node’s type as a string.

Methods

text(arg: str, /) → str

Get the node’s source text.

text is the full source text at the time of parsing. For example, if the associated TextDocument has not been modified:

def source_text(cst_node: syside.CstNode, document: syside.Document) -> str:
    if text_doc := document.text_document:
        with text_doc.lock() as text:
            return cst_node.text(text.text)

    ...

text() → str

Get the node’s source text from the associated TextDocument.

For performance reasons, modifications to the associated TextDocument after receiving this CST node may affect the returned source string. This will be fixed in a future update.

Used by

• syside.AstNode: cst_node

• syside.DocumentSegment: from_cst, from_cst_end, from_cst_start