Reading Sequences

Regardless of how you create a Sequence, you can consume it in a number of ways.

Reading the entire Sequence as a string

Simply print() a Sequence to print its entire stack as an encoded string.

You can also cast a Sequence to str or read its encoded property to get the string value.

Iterating through strings and Interpretation dictionaries

To iterate part-by-part through a Sequence, use the resolved generator.

from ansiscape import Sequence

sequence = Sequence("Hello world, and \033[3myou\033[23m in particular!")
for part in sequence.resolved:
    print(part)

Hello world, and 
{'calligraphy': <Calligraphy.ITALIC: 2>}
you
{'calligraphy': <Calligraphy.NONE: 0>}
 in particular!

Note that strings with embedded escape codes can be passed into the Sequence initialiser, but these will be converted to sub-sequences of plain strings and Interpretation dictionaries. The resolved property will never return strings with embedded escape codes.

Writing a JSON stream

To interpret a Sequence to JSON, pass a TextIO instance to the json_write() function.

from ansiscape import Sequence
from sys import stdout

sequence = Sequence("Hello world, and \033[3myou\033[23m in particular!")
sequence.write_json(stdout)

["Hello world, and ",{"calligraphy": 2},"you",{"calligraphy": 0}," in particular!"]