text_lint.results.cursor.ResultTreeCursor

class text_lint.results.cursor.ResultTreeCursor

Bases: object

Represents a location within a ResultForest instance.

__init__() → None

Initialize ResultTreeCursor instances.

clone() → ResultTreeCursor

Create a nested copy of all trees at the specified location.

Returns:

A cloned copy of the current cursor object.

Return type:

ResultTreeCursor

flatten() → None

Merge the current location’s tree groups.

increment_depth() → None

Increase tree depth by one set of nodes.

property location: List[ResultTree | AliasResultForestCursor]

Return the current location within the ResultForest instance.

unique() → None

Select the first unique value for each tree at the current location.