Skip to content

Print

Demo

Quick Start

print.py
from terminaltexteffects.effects.effect_print import Print

effect = Print("YourTextHere")
with effect.terminal_output() as terminal:
    for frame in effect:
        terminal.print(frame)

Prints the input data one line at at time with a carriage return and line feed.

Classes:

Name Description
Print

Prints the input data one line at at time with a carriage return and line feed.
PrintConfig

Configuration for the Print effect.
PrintIterator

Effect iterator for the Print effect. Does not normally need to be called directly.

Print

Bases: BaseEffect[PrintConfig]

Prints the input data one line at at time with a carriage return and line feed.

Attributes:

Name Type Description
effect_config PrintConfig

Configuration for the effect.
terminal_config TerminalConfig

Configuration for the terminal
Source code in terminaltexteffects/effects/effect_print.py 
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
class Print(BaseEffect[PrintConfig]):
    """Prints the input data one line at at time with a carriage return and line feed.

    Attributes:
        effect_config (PrintConfig): Configuration for the effect.
        terminal_config (TerminalConfig): Configuration for the terminal

    """

    @property
    def _config_cls(self) -> type[PrintConfig]:
        return PrintConfig

    @property
    def _iterator_cls(self) -> type[PrintIterator]:
        return PrintIterator

PrintConfig dataclass

Bases: BaseConfig

Configuration for the Print effect.

Attributes:

Name Type Description
print_head_return_speed float

Speed of the print head when performing a carriage return.
print_speed int

Speed of the print head when printing characters.
print_head_easing EasingFunction

Easing function to use for print head movement.
final_gradient_stops tuple[Color, ...]

Tuple of colors for the final color gradient. If only one " "color is provided, the characters will be displayed in that color.
final_gradient_steps tuple[int, ...] | int

Tuple of the number of gradient steps to use. More steps " "will create a smoother and longer gradient animation. Valid values are n > 0.
final_gradient_direction Direction

Direction of the final gradient.
Source code in terminaltexteffects/effects/effect_print.py 
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
@dataclass
class PrintConfig(BaseConfig):
    """Configuration for the Print effect.

    Attributes:
        print_head_return_speed (float): Speed of the print head when performing a carriage return.
        print_speed (int): Speed of the print head when printing characters.
        print_head_easing (easing.EasingFunction): Easing function to use for print head movement.
        final_gradient_stops (tuple[Color, ...]): Tuple of colors for the final color gradient. If only one "
            "color is provided, the characters will be displayed in that color.
        final_gradient_steps (tuple[int, ...] | int): Tuple of the number of gradient steps to use. More steps "
            "will create a smoother and longer gradient animation. Valid values are n > 0.
        final_gradient_direction (Gradient.Direction): Direction of the final gradient.

    """

    parser_spec: argutils.ParserSpec = argutils.ParserSpec(
        name="print",
        help="Lines are printed one at a time following a print head. Print head performs line feed, carriage return.",
        description="print | Lines are printed one at a time following a print head. Print head performs line feed, "
        "carriage return.",
        epilog=(
            f"{argutils.EASING_EPILOG} Example: terminaltexteffects print --final-gradient-stops 02b8bd "
            "c1f0e3 00ffa0 --final-gradient-steps 12 --final-gradient-direction diagonal "
            "--print-head-return-speed 1.5 --print-speed 2 --print-head-easing IN_OUT_QUAD"
        ),
    )
    print_head_return_speed: float = argutils.ArgSpec(
        name="--print-head-return-speed",
        type=argutils.PositiveFloat.type_parser,
        default=1.5,
        metavar=argutils.PositiveFloat.METAVAR,
        help="Speed of the print head when performing a carriage return.",
    )  # pyright: ignore[reportAssignmentType]
    "float : Speed of the print head when performing a carriage return."

    print_speed: int = argutils.ArgSpec(
        name="--print-speed",
        type=argutils.PositiveInt.type_parser,
        default=2,
        metavar=argutils.PositiveInt.METAVAR,
        help="Speed of the print head when printing characters.",
    )  # pyright: ignore[reportAssignmentType]
    "int : Speed of the print head when printing characters."

    print_head_easing: easing.EasingFunction = argutils.ArgSpec(
        name="--print-head-easing",
        default=easing.in_out_quad,
        type=argutils.Ease.type_parser,
        help="Easing function to use for print head movement.",
    )  # pyright: ignore[reportAssignmentType]
    "easing.EasingFunction : Easing function to use for print head movement."

    final_gradient_stops: tuple[Color, ...] = FinalGradientStopsArg(
        default=(Color("#02b8bd"), Color("#c1f0e3"), Color("#00ffa0")),
    )  # pyright: ignore[reportAssignmentType]
    (
        "tuple[Color, ...] : Tuple of colors for the final color gradient. If only one color is provided, the "
        "characters will be displayed in that color."
    )

    final_gradient_steps: tuple[int, ...] | int = FinalGradientStepsArg(
        default=12,
    )  # pyright: ignore[reportAssignmentType]
    (
        "tuple[int, ...] | int : Int or Tuple of ints for the number of gradient steps to use. More steps will "
        "create a smoother and longer gradient animation."
    )

    final_gradient_direction: Gradient.Direction = FinalGradientDirectionArg(
        default=Gradient.Direction.DIAGONAL,
    )  # pyright: ignore[reportAssignmentType]
    "Gradient.Direction : Direction of the final gradient."

final_gradient_direction = FinalGradientDirectionArg(default=(Gradient.Direction.DIAGONAL)) class-attribute instance-attribute

Gradient.Direction : Direction of the final gradient.

final_gradient_steps = FinalGradientStepsArg(default=12) class-attribute instance-attribute

tuple[int, ...] | int : Int or Tuple of ints for the number of gradient steps to use. More steps will create a smoother and longer gradient animation.

final_gradient_stops = FinalGradientStopsArg(default=(Color('#02b8bd'), Color('#c1f0e3'), Color('#00ffa0'))) class-attribute instance-attribute

tuple[Color, ...] : Tuple of colors for the final color gradient. If only one color is provided, the characters will be displayed in that color.

print_head_easing = argutils.ArgSpec(name='--print-head-easing', default=(easing.in_out_quad), type=(argutils.Ease.type_parser), help='Easing function to use for print head movement.') class-attribute instance-attribute

easing.EasingFunction : Easing function to use for print head movement.

print_head_return_speed = argutils.ArgSpec(name='--print-head-return-speed', type=(argutils.PositiveFloat.type_parser), default=1.5, metavar=(argutils.PositiveFloat.METAVAR), help='Speed of the print head when performing a carriage return.') class-attribute instance-attribute

float : Speed of the print head when performing a carriage return.

print_speed = argutils.ArgSpec(name='--print-speed', type=(argutils.PositiveInt.type_parser), default=2, metavar=(argutils.PositiveInt.METAVAR), help='Speed of the print head when printing characters.') class-attribute instance-attribute

int : Speed of the print head when printing characters.

PrintIterator

Bases: BaseEffectIterator[PrintConfig]

Effect iterator for the Print effect.

Source code in terminaltexteffects/effects/effect_print.py 
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
class PrintIterator(BaseEffectIterator[PrintConfig]):
    """Effect iterator for the Print effect."""

    class Row:
        """Row of characters to print."""

        def __init__(
            self,
            characters: list[EffectCharacter],
            character_final_color_map: dict[EffectCharacter, ColorPair],
            typing_head_color: Color,
            existing_color_handling: str,
        ) -> None:
            """Initialize the row of characters to print.

            Args:
                characters (list[EffectCharacter]): List of characters to print.
                character_final_color_map (dict[EffectCharacter, ColorPair]): Mapping of
                    characters to their final colors.
                typing_head_color (Color): Color of the typing head.
                existing_color_handling (str): Existing color handling mode for the terminal.

            """
            self.untyped_chars: list[EffectCharacter] = []
            self.typed_chars: list[EffectCharacter] = []
            if all(character.input_symbol == " " for character in characters):
                characters = characters[:1]
            else:
                right_extent = max(
                    character.input_coord.column for character in characters if not character.is_fill_character
                )
                characters = [char for char in characters if char.input_coord.column <= right_extent]
            for character in characters:
                character.motion.set_coordinate(Coord(character.input_coord.column, 1))
                typed_animation = character.animation.new_scene()
                if existing_color_handling == "dynamic":
                    final_fg_color = character_final_color_map[character].fg_color
                    final_bg_color = character_final_color_map[character].bg_color
                    fg_gradient = Gradient(typing_head_color, final_fg_color, steps=5) if final_fg_color else None
                    bg_gradient = Gradient(typing_head_color, final_bg_color, steps=5) if final_bg_color else None
                    if fg_gradient or bg_gradient:
                        typed_animation.apply_gradient_to_symbols(
                            ("█", "▓", "▒", "░", character.input_symbol),
                            3,
                            fg_gradient=fg_gradient,
                            bg_gradient=bg_gradient,
                        )
                    else:
                        typed_animation.apply_gradient_to_symbols(
                            ("█", "▓", "▒", "░"),
                            3,
                            fg_gradient=Gradient(typing_head_color, typing_head_color, steps=4),
                        )
                        typed_animation.add_frame(character.input_symbol, 3, colors=ColorPair())
                else:
                    final_fg_color = character_final_color_map[character].fg_color
                    assert final_fg_color is not None
                    color_gradient = Gradient(typing_head_color, final_fg_color, steps=5)
                    typed_animation.apply_gradient_to_symbols(
                        ("█", "▓", "▒", "░", character.input_symbol),
                        3,
                        fg_gradient=color_gradient,
                    )
                character.animation.activate_scene(typed_animation)
                self.untyped_chars.append(character)

        def move_up(self) -> None:
            """Move the row up one row."""
            for character in self.typed_chars:
                current_row = character.motion.current_coord.row
                character.motion.set_coordinate(Coord(character.motion.current_coord.column, current_row + 1))

        def type_char(self) -> EffectCharacter | None:
            """Type the next character in the row."""
            if self.untyped_chars:
                next_char = self.untyped_chars.pop(0)
                self.typed_chars.append(next_char)
                return next_char
            return None

    def __init__(self, effect: Print) -> None:
        """Initialize the iterator with the Print effect.

        Args:
            effect (Print): Print effect to apply to the input data.

        """
        super().__init__(effect)
        self.pending_chars: list[EffectCharacter] = []
        self.pending_rows: list[PrintIterator.Row] = []
        self.processed_rows: list[PrintIterator.Row] = []
        self.typing_head = self.terminal.add_character("█", Coord(1, 1))
        self.character_final_color_map: dict[EffectCharacter, ColorPair] = {}
        self.build()

    def build(self) -> None:
        """Build the initial state of the effect."""
        self.final_gradient = Gradient(*self.config.final_gradient_stops, steps=self.config.final_gradient_steps)
        final_gradient_mapping = self.final_gradient.build_coordinate_color_mapping(
            self.terminal.canvas.text_bottom,
            self.terminal.canvas.text_top,
            self.terminal.canvas.text_left,
            self.terminal.canvas.text_right,
            self.config.final_gradient_direction,
        )
        for character in self.terminal.get_characters(outer_fill_chars=True, inner_fill_chars=True):
            if self.terminal.config.existing_color_handling == "dynamic":
                self.character_final_color_map[character] = ColorPair(
                    fg=character.animation.input_fg_color,
                    bg=character.animation.input_bg_color,
                )
            else:
                self.character_final_color_map[character] = ColorPair(
                    fg=final_gradient_mapping.get(
                        character.input_coord,
                        Color("#ffffff"),
                    ),
                )
        input_rows = self.terminal.get_characters_grouped(
            grouping=argutils.CharacterGroup.ROW_TOP_TO_BOTTOM,
            outer_fill_chars=True,
            inner_fill_chars=True,
        )
        for input_row in input_rows:
            self.pending_rows.append(
                PrintIterator.Row(
                    input_row,
                    self.character_final_color_map,
                    Color("#ffffff"),
                    self.terminal.config.existing_color_handling,
                ),
            )
        self._current_row: PrintIterator.Row = self.pending_rows.pop(0)
        self._typing = True
        self._last_column = 0

    def __next__(self) -> str:
        """Return the next frame in the animation."""
        if self.active_characters or self._typing:
            if self.typing_head.motion.active_path:
                pass
            elif self._current_row.untyped_chars:
                for _ in range(min(len(self._current_row.untyped_chars), self.config.print_speed)):
                    next_char = self._current_row.type_char()
                    if next_char:
                        self.terminal.set_character_visibility(next_char, is_visible=True)
                        self.active_characters.add(next_char)
                        self._last_column = next_char.input_coord.column
            else:
                self.processed_rows.append(self._current_row)
                if self.pending_rows:
                    for row in self.processed_rows:
                        row.move_up()
                    self._current_row = self.pending_rows.pop(0)
                    if not all(
                        character.is_fill_character for character in self.processed_rows[-1].typed_chars
                    ) and not all(character.is_fill_character for character in self._current_row.untyped_chars):
                        left_extent = min(
                            [
                                character.input_coord.column
                                for character in self._current_row.untyped_chars
                                if not character.is_fill_character
                            ],
                        )
                        self._current_row.untyped_chars = [
                            char
                            for char in self._current_row.untyped_chars
                            if left_extent <= char.input_coord.column <= self.terminal.canvas.text_right
                        ]
                    self.typing_head.motion.set_coordinate(Coord(self._last_column, 1))
                    self.terminal.set_character_visibility(self.typing_head, is_visible=True)
                    self.typing_head.motion.paths.clear()
                    carriage_return_path = self.typing_head.motion.new_path(
                        speed=self.config.print_head_return_speed,
                        ease=self.config.print_head_easing,
                        path_id="carriage_return_path",
                    )
                    carriage_return_path.new_waypoint(
                        Coord(self._current_row.untyped_chars[0].input_coord.column, 1),
                    )
                    self.typing_head.motion.activate_path(carriage_return_path)
                    with contextlib.suppress(DuplicateEventRegistrationError):
                        self.typing_head.event_handler.register_event(
                            EventHandler.Event.PATH_COMPLETE,
                            carriage_return_path,
                            EventHandler.Action.CALLBACK,
                            EventHandler.Callback(self.terminal.set_character_visibility, False),  # noqa: FBT003
                        )

                    self.active_characters.add(self.typing_head)
                else:
                    self._typing = False
            self.update()
            return self.frame
        raise StopIteration

Row

Row of characters to print.

Source code in terminaltexteffects/effects/effect_print.py 
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
class Row:
    """Row of characters to print."""

    def __init__(
        self,
        characters: list[EffectCharacter],
        character_final_color_map: dict[EffectCharacter, ColorPair],
        typing_head_color: Color,
        existing_color_handling: str,
    ) -> None:
        """Initialize the row of characters to print.

        Args:
            characters (list[EffectCharacter]): List of characters to print.
            character_final_color_map (dict[EffectCharacter, ColorPair]): Mapping of
                characters to their final colors.
            typing_head_color (Color): Color of the typing head.
            existing_color_handling (str): Existing color handling mode for the terminal.

        """
        self.untyped_chars: list[EffectCharacter] = []
        self.typed_chars: list[EffectCharacter] = []
        if all(character.input_symbol == " " for character in characters):
            characters = characters[:1]
        else:
            right_extent = max(
                character.input_coord.column for character in characters if not character.is_fill_character
            )
            characters = [char for char in characters if char.input_coord.column <= right_extent]
        for character in characters:
            character.motion.set_coordinate(Coord(character.input_coord.column, 1))
            typed_animation = character.animation.new_scene()
            if existing_color_handling == "dynamic":
                final_fg_color = character_final_color_map[character].fg_color
                final_bg_color = character_final_color_map[character].bg_color
                fg_gradient = Gradient(typing_head_color, final_fg_color, steps=5) if final_fg_color else None
                bg_gradient = Gradient(typing_head_color, final_bg_color, steps=5) if final_bg_color else None
                if fg_gradient or bg_gradient:
                    typed_animation.apply_gradient_to_symbols(
                        ("█", "▓", "▒", "░", character.input_symbol),
                        3,
                        fg_gradient=fg_gradient,
                        bg_gradient=bg_gradient,
                    )
                else:
                    typed_animation.apply_gradient_to_symbols(
                        ("█", "▓", "▒", "░"),
                        3,
                        fg_gradient=Gradient(typing_head_color, typing_head_color, steps=4),
                    )
                    typed_animation.add_frame(character.input_symbol, 3, colors=ColorPair())
            else:
                final_fg_color = character_final_color_map[character].fg_color
                assert final_fg_color is not None
                color_gradient = Gradient(typing_head_color, final_fg_color, steps=5)
                typed_animation.apply_gradient_to_symbols(
                    ("█", "▓", "▒", "░", character.input_symbol),
                    3,
                    fg_gradient=color_gradient,
                )
            character.animation.activate_scene(typed_animation)
            self.untyped_chars.append(character)

    def move_up(self) -> None:
        """Move the row up one row."""
        for character in self.typed_chars:
            current_row = character.motion.current_coord.row
            character.motion.set_coordinate(Coord(character.motion.current_coord.column, current_row + 1))

    def type_char(self) -> EffectCharacter | None:
        """Type the next character in the row."""
        if self.untyped_chars:
            next_char = self.untyped_chars.pop(0)
            self.typed_chars.append(next_char)
            return next_char
        return None

__init__(characters, character_final_color_map, typing_head_color, existing_color_handling)

Initialize the row of characters to print.

Parameters:

Name Type Description Default
characters list[EffectCharacter]

List of characters to print.

 required
character_final_color_map dict[EffectCharacter, ColorPair]

Mapping of characters to their final colors.

 required
typing_head_color Color

Color of the typing head.

 required
existing_color_handling str

Existing color handling mode for the terminal.

 required
Source code in terminaltexteffects/effects/effect_print.py 
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
def __init__(
    self,
    characters: list[EffectCharacter],
    character_final_color_map: dict[EffectCharacter, ColorPair],
    typing_head_color: Color,
    existing_color_handling: str,
) -> None:
    """Initialize the row of characters to print.

    Args:
        characters (list[EffectCharacter]): List of characters to print.
        character_final_color_map (dict[EffectCharacter, ColorPair]): Mapping of
            characters to their final colors.
        typing_head_color (Color): Color of the typing head.
        existing_color_handling (str): Existing color handling mode for the terminal.

    """
    self.untyped_chars: list[EffectCharacter] = []
    self.typed_chars: list[EffectCharacter] = []
    if all(character.input_symbol == " " for character in characters):
        characters = characters[:1]
    else:
        right_extent = max(
            character.input_coord.column for character in characters if not character.is_fill_character
        )
        characters = [char for char in characters if char.input_coord.column <= right_extent]
    for character in characters:
        character.motion.set_coordinate(Coord(character.input_coord.column, 1))
        typed_animation = character.animation.new_scene()
        if existing_color_handling == "dynamic":
            final_fg_color = character_final_color_map[character].fg_color
            final_bg_color = character_final_color_map[character].bg_color
            fg_gradient = Gradient(typing_head_color, final_fg_color, steps=5) if final_fg_color else None
            bg_gradient = Gradient(typing_head_color, final_bg_color, steps=5) if final_bg_color else None
            if fg_gradient or bg_gradient:
                typed_animation.apply_gradient_to_symbols(
                    ("█", "▓", "▒", "░", character.input_symbol),
                    3,
                    fg_gradient=fg_gradient,
                    bg_gradient=bg_gradient,
                )
            else:
                typed_animation.apply_gradient_to_symbols(
                    ("█", "▓", "▒", "░"),
                    3,
                    fg_gradient=Gradient(typing_head_color, typing_head_color, steps=4),
                )
                typed_animation.add_frame(character.input_symbol, 3, colors=ColorPair())
        else:
            final_fg_color = character_final_color_map[character].fg_color
            assert final_fg_color is not None
            color_gradient = Gradient(typing_head_color, final_fg_color, steps=5)
            typed_animation.apply_gradient_to_symbols(
                ("█", "▓", "▒", "░", character.input_symbol),
                3,
                fg_gradient=color_gradient,
            )
        character.animation.activate_scene(typed_animation)
        self.untyped_chars.append(character)

move_up()

Move the row up one row.

Source code in terminaltexteffects/effects/effect_print.py 
177
178
179
180
181
def move_up(self) -> None:
    """Move the row up one row."""
    for character in self.typed_chars:
        current_row = character.motion.current_coord.row
        character.motion.set_coordinate(Coord(character.motion.current_coord.column, current_row + 1))

type_char()

Type the next character in the row.

Source code in terminaltexteffects/effects/effect_print.py 
183
184
185
186
187
188
189
def type_char(self) -> EffectCharacter | None:
    """Type the next character in the row."""
    if self.untyped_chars:
        next_char = self.untyped_chars.pop(0)
        self.typed_chars.append(next_char)
        return next_char
    return None

__init__(effect)

Initialize the iterator with the Print effect.

Parameters:

Name Type Description Default
effect Print

Print effect to apply to the input data.

 required
Source code in terminaltexteffects/effects/effect_print.py 
191
192
193
194
195
196
197
198
199
200
201
202
203
204
def __init__(self, effect: Print) -> None:
    """Initialize the iterator with the Print effect.

    Args:
        effect (Print): Print effect to apply to the input data.

    """
    super().__init__(effect)
    self.pending_chars: list[EffectCharacter] = []
    self.pending_rows: list[PrintIterator.Row] = []
    self.processed_rows: list[PrintIterator.Row] = []
    self.typing_head = self.terminal.add_character("█", Coord(1, 1))
    self.character_final_color_map: dict[EffectCharacter, ColorPair] = {}
    self.build()

__next__()

Return the next frame in the animation.

Source code in terminaltexteffects/effects/effect_print.py 
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
def __next__(self) -> str:
    """Return the next frame in the animation."""
    if self.active_characters or self._typing:
        if self.typing_head.motion.active_path:
            pass
        elif self._current_row.untyped_chars:
            for _ in range(min(len(self._current_row.untyped_chars), self.config.print_speed)):
                next_char = self._current_row.type_char()
                if next_char:
                    self.terminal.set_character_visibility(next_char, is_visible=True)
                    self.active_characters.add(next_char)
                    self._last_column = next_char.input_coord.column
        else:
            self.processed_rows.append(self._current_row)
            if self.pending_rows:
                for row in self.processed_rows:
                    row.move_up()
                self._current_row = self.pending_rows.pop(0)
                if not all(
                    character.is_fill_character for character in self.processed_rows[-1].typed_chars
                ) and not all(character.is_fill_character for character in self._current_row.untyped_chars):
                    left_extent = min(
                        [
                            character.input_coord.column
                            for character in self._current_row.untyped_chars
                            if not character.is_fill_character
                        ],
                    )
                    self._current_row.untyped_chars = [
                        char
                        for char in self._current_row.untyped_chars
                        if left_extent <= char.input_coord.column <= self.terminal.canvas.text_right
                    ]
                self.typing_head.motion.set_coordinate(Coord(self._last_column, 1))
                self.terminal.set_character_visibility(self.typing_head, is_visible=True)
                self.typing_head.motion.paths.clear()
                carriage_return_path = self.typing_head.motion.new_path(
                    speed=self.config.print_head_return_speed,
                    ease=self.config.print_head_easing,
                    path_id="carriage_return_path",
                )
                carriage_return_path.new_waypoint(
                    Coord(self._current_row.untyped_chars[0].input_coord.column, 1),
                )
                self.typing_head.motion.activate_path(carriage_return_path)
                with contextlib.suppress(DuplicateEventRegistrationError):
                    self.typing_head.event_handler.register_event(
                        EventHandler.Event.PATH_COMPLETE,
                        carriage_return_path,
                        EventHandler.Action.CALLBACK,
                        EventHandler.Callback(self.terminal.set_character_visibility, False),  # noqa: FBT003
                    )

                self.active_characters.add(self.typing_head)
            else:
                self._typing = False
        self.update()
        return self.frame
    raise StopIteration

build()

Build the initial state of the effect.

Source code in terminaltexteffects/effects/effect_print.py 
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
def build(self) -> None:
    """Build the initial state of the effect."""
    self.final_gradient = Gradient(*self.config.final_gradient_stops, steps=self.config.final_gradient_steps)
    final_gradient_mapping = self.final_gradient.build_coordinate_color_mapping(
        self.terminal.canvas.text_bottom,
        self.terminal.canvas.text_top,
        self.terminal.canvas.text_left,
        self.terminal.canvas.text_right,
        self.config.final_gradient_direction,
    )
    for character in self.terminal.get_characters(outer_fill_chars=True, inner_fill_chars=True):
        if self.terminal.config.existing_color_handling == "dynamic":
            self.character_final_color_map[character] = ColorPair(
                fg=character.animation.input_fg_color,
                bg=character.animation.input_bg_color,
            )
        else:
            self.character_final_color_map[character] = ColorPair(
                fg=final_gradient_mapping.get(
                    character.input_coord,
                    Color("#ffffff"),
                ),
            )
    input_rows = self.terminal.get_characters_grouped(
        grouping=argutils.CharacterGroup.ROW_TOP_TO_BOTTOM,
        outer_fill_chars=True,
        inner_fill_chars=True,
    )
    for input_row in input_rows:
        self.pending_rows.append(
            PrintIterator.Row(
                input_row,
                self.character_final_color_map,
                Color("#ffffff"),
                self.terminal.config.existing_color_handling,
            ),
        )
    self._current_row: PrintIterator.Row = self.pending_rows.pop(0)
    self._typing = True
    self._last_column = 0

get_effect_resources()

Get the command, effect class, and configuration class for the effect.

Returns:

Type Description
tuple[str, type[BaseEffect], type[BaseConfig]]

tuple[str, type[BaseEffect], type[BaseConfig]]: The command name, effect class, and configuration class.
Source code in terminaltexteffects/effects/effect_print.py 
26
27
28
29
30
31
32
33
def get_effect_resources() -> tuple[str, type[BaseEffect], type[BaseConfig]]:
    """Get the command, effect class, and configuration class for the effect.

    Returns:
        tuple[str, type[BaseEffect], type[BaseConfig]]: The command name, effect class, and configuration class.

    """
    return "print", Print, PrintConfig