Skip to content

Overflow

Demo

Quick Start

overflow.py
from terminaltexteffects.effects.effect_overflow import Overflow

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

Input text overflows and scrolls the terminal in a random order until eventually appearing ordered.

Classes:

Name Description
Overflow

Input text overflows and scrolls the terminal in a random order until eventually appearing ordered.
OverflowConfig

Configuration for the Overflow effect.
OverflowIterator

Iterates over the effect. Does not normally need to be called directly.

Overflow

Bases: BaseEffect[OverflowConfig]

Input text overflows and scrolls the terminal in a random order until eventually appearing ordered.

Attributes:

Name Type Description
effect_config OverflowConfig

Configuration for the effect.
terminal_config TerminalConfig

Configuration for the terminal.
Source code in terminaltexteffects/effects/effect_overflow.py 
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
class Overflow(BaseEffect[OverflowConfig]):
    """Input text overflows and scrolls the terminal in a random order until eventually appearing ordered.

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

    """

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

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

OverflowConfig dataclass

Bases: ArgsDataClass

Configuration for the Overflow effect.

Attributes:

Name Type Description
overflow_gradient_stops tuple[Color, ...]

Tuple of colors for the overflow gradient.
overflow_cycles_range tuple[int, int]

Lower and upper range of the number of cycles to overflow the text. " "Valid values are n >= 0.
overflow_speed int

Speed of the overflow effect. Valid values are n > 0.
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_overflow.py 
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 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
109
110
111
112
113
114
115
116
117
118
119
120
121
122
@argclass(
    name="overflow",
    help="Input text overflows and scrolls the terminal in a random order until eventually appearing ordered.",
    description="overflow | Input text overflows and scrolls the terminal in a random order until eventually "
    "appearing ordered.",
    epilog=(
        "Example: terminaltexteffects overflow --final-gradient-stops 8A008A 00D1FF FFFFFF "
        "--final-gradient-steps 12 --overflow-gradient-stops f2ebc0 8dbfb3 f2ebc0 --overflow-cycles-range 2-4 "
        "--overflow-speed 3"
    ),
)
@dataclass
class OverflowConfig(ArgsDataClass):
    """Configuration for the Overflow effect.

    Attributes:
        overflow_gradient_stops (tuple[Color, ...]): Tuple of colors for the overflow gradient.
        overflow_cycles_range (tuple[int, int]): Lower and upper range of the number of cycles to overflow the text. "
            "Valid values are n >= 0.
        overflow_speed (int): Speed of the overflow effect. Valid values are n > 0.
        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.

    """

    overflow_gradient_stops: tuple[Color, ...] = ArgField(
        cmd_name=["--overflow-gradient-stops"],
        type_parser=argvalidators.ColorArg.type_parser,
        nargs="+",
        default=(Color("f2ebc0"), Color("8dbfb3"), Color("f2ebc0")),
        metavar=argvalidators.ColorArg.METAVAR,
        help="Space separated, unquoted, list of colors for the overflow gradient.",
    )  # type: ignore[assignment]
    "tuple[Color, ...] : Tuple of colors for the overflow gradient."

    overflow_cycles_range: tuple[int, int] = ArgField(
        cmd_name=["--overflow-cycles-range"],
        type_parser=argvalidators.PositiveIntRange.type_parser,
        default=(2, 4),
        metavar=argvalidators.PositiveIntRange.METAVAR,
        help="Number of cycles to overflow the text.",
    )  # type: ignore[assignment]
    "tuple[int, int] : Lower and upper range of the number of cycles to overflow the text."

    overflow_speed: int = ArgField(
        cmd_name=["--overflow-speed"],
        type_parser=argvalidators.PositiveInt.type_parser,
        default=3,
        metavar=argvalidators.PositiveInt.METAVAR,
        help="Speed of the overflow effect.",
    )  # type: ignore[assignment]
    "int : Speed of the overflow effect."

    final_gradient_stops: tuple[Color, ...] = ArgField(
        cmd_name=["--final-gradient-stops"],
        type_parser=argvalidators.ColorArg.type_parser,
        nargs="+",
        default=(Color("8A008A"), Color("00D1FF"), Color("FFFFFF")),
        metavar=argvalidators.ColorArg.METAVAR,
        help="Space separated, unquoted, list of colors for the character gradient (applied across the canvas). If "
        "only one color is provided, the characters will be displayed in that color.",
    )  # type: ignore[assignment]
    (
        "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 = ArgField(
        cmd_name=["--final-gradient-steps"],
        type_parser=argvalidators.PositiveInt.type_parser,
        nargs="+",
        default=12,
        metavar=argvalidators.PositiveInt.METAVAR,
        help="Space separated, unquoted, list of the number of gradient steps to use. More steps will create a "
        "smoother and longer gradient animation.",
    )  # type: ignore[assignment]
    (
        "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 = ArgField(
        cmd_name="--final-gradient-direction",
        type_parser=argvalidators.GradientDirection.type_parser,
        default=Gradient.Direction.VERTICAL,
        metavar=argvalidators.GradientDirection.METAVAR,
        help="Direction of the final gradient.",
    )  # type: ignore[assignment]
    "Gradient.Direction : Direction of the final gradient."

    @classmethod
    def get_effect_class(cls) -> type[Overflow]:
        """Get the effect class associated with this configuration."""
        return Overflow

final_gradient_direction = ArgField(cmd_name='--final-gradient-direction', type_parser=argvalidators.GradientDirection.type_parser, default=Gradient.Direction.VERTICAL, metavar=argvalidators.GradientDirection.METAVAR, help='Direction of the final gradient.') class-attribute instance-attribute

Gradient.Direction : Direction of the final gradient.

final_gradient_steps = ArgField(cmd_name=['--final-gradient-steps'], type_parser=argvalidators.PositiveInt.type_parser, nargs='+', default=12, metavar=argvalidators.PositiveInt.METAVAR, help='Space separated, unquoted, list of the number of gradient steps to use. More steps will create a smoother and longer gradient animation.') 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 = ArgField(cmd_name=['--final-gradient-stops'], type_parser=argvalidators.ColorArg.type_parser, nargs='+', default=(Color('8A008A'), Color('00D1FF'), Color('FFFFFF')), metavar=argvalidators.ColorArg.METAVAR, help='Space separated, unquoted, list of colors for the character gradient (applied across the canvas). If only one color is provided, the characters will be displayed in that color.') 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.

overflow_cycles_range = ArgField(cmd_name=['--overflow-cycles-range'], type_parser=argvalidators.PositiveIntRange.type_parser, default=(2, 4), metavar=argvalidators.PositiveIntRange.METAVAR, help='Number of cycles to overflow the text.') class-attribute instance-attribute

tuple[int, int] : Lower and upper range of the number of cycles to overflow the text.

overflow_gradient_stops = ArgField(cmd_name=['--overflow-gradient-stops'], type_parser=argvalidators.ColorArg.type_parser, nargs='+', default=(Color('f2ebc0'), Color('8dbfb3'), Color('f2ebc0')), metavar=argvalidators.ColorArg.METAVAR, help='Space separated, unquoted, list of colors for the overflow gradient.') class-attribute instance-attribute

tuple[Color, ...] : Tuple of colors for the overflow gradient.

overflow_speed = ArgField(cmd_name=['--overflow-speed'], type_parser=argvalidators.PositiveInt.type_parser, default=3, metavar=argvalidators.PositiveInt.METAVAR, help='Speed of the overflow effect.') class-attribute instance-attribute

int : Speed of the overflow effect.

get_effect_class() classmethod

Get the effect class associated with this configuration.

Source code in terminaltexteffects/effects/effect_overflow.py 
119
120
121
122
@classmethod
def get_effect_class(cls) -> type[Overflow]:
    """Get the effect class associated with this configuration."""
    return Overflow

OverflowIterator

Bases: BaseEffectIterator[OverflowConfig]

Iterates over the effect.

Source code in terminaltexteffects/effects/effect_overflow.py 
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
class OverflowIterator(BaseEffectIterator[OverflowConfig]):
    """Iterates over the effect."""

    class Row:
        """Represents a row of characters in the overflow effect."""

        def __init__(self, characters: list[EffectCharacter], *, final: bool = False) -> None:
            """Initialize the row.

            Args:
                characters (list[EffectCharacter]): The characters in the row.
                final (bool, optional): This is the final state of the row. Defaults to False.

            """
            self.characters = characters
            self.current_index = 0
            self.final = final

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

        def setup(self) -> None:
            """Set up the row for display."""
            for character in self.characters:
                character.motion.set_coordinate(Coord(character.input_coord.column, 0))

        def set_color(self, fg_color: Color | None = None, bg_color: Color | None = None) -> None:
            """Set the color of the row."""
            for character in self.characters:
                character.animation.set_appearance(
                    character.input_symbol,
                    ColorPair(fg=fg_color, bg=bg_color),
                )

    def __init__(self, effect: Overflow) -> None:
        """Initialize the effect iterator."""
        super().__init__(effect)
        self.pending_chars: list[EffectCharacter] = []
        self.pending_rows: list[OverflowIterator.Row] = []
        self.active_rows: list[OverflowIterator.Row] = []
        self.character_final_color_map: dict[EffectCharacter, Color] = {}
        self.build()

    def build(self) -> None:
        """Build the initial state of the effect."""
        final_gradient = Gradient(*self.config.final_gradient_stops, steps=self.config.final_gradient_steps)
        final_gradient_mapping = 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):
            self.character_final_color_map[character] = final_gradient_mapping.get(
                character.input_coord,
                Color("000000"),
            )
        lower_range, upper_range = self.config.overflow_cycles_range
        rows = self.terminal.get_characters_grouped(Terminal.CharacterGroup.ROW_TOP_TO_BOTTOM)
        if upper_range > 0:
            for _ in range(random.randint(lower_range, upper_range)):
                random.shuffle(rows)
                for row in rows:
                    copied_characters = []
                    # copy the character attributes to new characters
                    for character in row:
                        character_copy = self.terminal.add_character(character.input_symbol, character.input_coord)
                        character_copy.animation.existing_color_handling = self.terminal.config.existing_color_handling
                        character_copy._input_ansi_sequences = character._input_ansi_sequences
                        character_copy.animation.no_color = character.animation.no_color
                        character_copy.animation.use_xterm_colors = character.animation.use_xterm_colors
                        character_copy.animation.input_fg_color = character.animation.input_fg_color
                        character_copy.animation.input_bg_color = character.animation.input_bg_color
                        copied_characters.append(character_copy)
                    self.pending_rows.append(OverflowIterator.Row(copied_characters))
        # add rows in correct order to the end of self.pending_rows
        for row in self.terminal.get_characters_grouped(
            Terminal.CharacterGroup.ROW_TOP_TO_BOTTOM,
            outer_fill_chars=True,
            inner_fill_chars=True,
        ):
            next_row = OverflowIterator.Row(row)
            for character in next_row.characters:
                if self.terminal.config.existing_color_handling == "dynamic" and any(
                    (character.animation.input_fg_color, character.animation.input_bg_color),
                ):
                    character.animation.set_appearance(
                        character.animation.current_character_visual.symbol,
                        ColorPair(
                            fg=character.animation.input_fg_color,
                            bg=character.animation.input_bg_color,
                        ),
                    )
                else:
                    character.animation.set_appearance(
                        character.animation.current_character_visual.symbol,
                        ColorPair(fg=self.character_final_color_map[character]),
                    )
            self.pending_rows.append(OverflowIterator.Row(row, final=True))
        self._delay = 0
        self._overflow_gradient = Gradient(
            *self.config.overflow_gradient_stops,
            steps=max((self.terminal.canvas.top // max(1, len(self.config.overflow_gradient_stops) - 1)), 1),
        )

    def __next__(self) -> str:
        """Return the next frame in the animation."""
        if self.pending_rows:
            if not self._delay:
                for _ in range(random.randint(1, self.config.overflow_speed)):
                    if self.pending_rows:
                        for row in self.active_rows:
                            row.move_up()
                            if not row.final:
                                row.set_color(
                                    self._overflow_gradient.spectrum[
                                        min(
                                            row.characters[0].motion.current_coord.row,
                                            len(self._overflow_gradient.spectrum) - 1,
                                        )
                                    ],
                                )
                        next_row = self.pending_rows.pop(0)
                        next_row.setup()
                        next_row.move_up()
                        if not next_row.final:
                            next_row.set_color(self._overflow_gradient.spectrum[0])
                        for character in next_row.characters:
                            self.terminal.set_character_visibility(character, is_visible=True)
                        self.active_rows.append(next_row)
                self._delay = random.randint(0, 3)

            else:
                self._delay -= 1
            self.active_rows = [
                row
                for row in self.active_rows
                if row.characters[0].motion.current_coord.row <= self.terminal.canvas.top
            ]
            self.update()
            return self.frame
        raise StopIteration

Row

Represents a row of characters in the overflow effect.

Source code in terminaltexteffects/effects/effect_overflow.py 
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
class Row:
    """Represents a row of characters in the overflow effect."""

    def __init__(self, characters: list[EffectCharacter], *, final: bool = False) -> None:
        """Initialize the row.

        Args:
            characters (list[EffectCharacter]): The characters in the row.
            final (bool, optional): This is the final state of the row. Defaults to False.

        """
        self.characters = characters
        self.current_index = 0
        self.final = final

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

    def setup(self) -> None:
        """Set up the row for display."""
        for character in self.characters:
            character.motion.set_coordinate(Coord(character.input_coord.column, 0))

    def set_color(self, fg_color: Color | None = None, bg_color: Color | None = None) -> None:
        """Set the color of the row."""
        for character in self.characters:
            character.animation.set_appearance(
                character.input_symbol,
                ColorPair(fg=fg_color, bg=bg_color),
            )

__init__(characters, *, final=False)

Initialize the row.

Parameters:

Name Type Description Default
characters list[EffectCharacter]

The characters in the row.

 required
final bool

This is the final state of the row. Defaults to False.

 False
Source code in terminaltexteffects/effects/effect_overflow.py 
131
132
133
134
135
136
137
138
139
140
141
def __init__(self, characters: list[EffectCharacter], *, final: bool = False) -> None:
    """Initialize the row.

    Args:
        characters (list[EffectCharacter]): The characters in the row.
        final (bool, optional): This is the final state of the row. Defaults to False.

    """
    self.characters = characters
    self.current_index = 0
    self.final = final

move_up()

Move the row up by one row.

Source code in terminaltexteffects/effects/effect_overflow.py 
143
144
145
146
147
def move_up(self) -> None:
    """Move the row up by one row."""
    for character in self.characters:
        current_row = character.motion.current_coord.row
        character.motion.set_coordinate(Coord(character.motion.current_coord.column, current_row + 1))

set_color(fg_color=None, bg_color=None)

Set the color of the row.

Source code in terminaltexteffects/effects/effect_overflow.py 
154
155
156
157
158
159
160
def set_color(self, fg_color: Color | None = None, bg_color: Color | None = None) -> None:
    """Set the color of the row."""
    for character in self.characters:
        character.animation.set_appearance(
            character.input_symbol,
            ColorPair(fg=fg_color, bg=bg_color),
        )

setup()

Set up the row for display.

Source code in terminaltexteffects/effects/effect_overflow.py 
149
150
151
152
def setup(self) -> None:
    """Set up the row for display."""
    for character in self.characters:
        character.motion.set_coordinate(Coord(character.input_coord.column, 0))

__init__(effect)

Initialize the effect iterator.

Source code in terminaltexteffects/effects/effect_overflow.py 
162
163
164
165
166
167
168
169
def __init__(self, effect: Overflow) -> None:
    """Initialize the effect iterator."""
    super().__init__(effect)
    self.pending_chars: list[EffectCharacter] = []
    self.pending_rows: list[OverflowIterator.Row] = []
    self.active_rows: list[OverflowIterator.Row] = []
    self.character_final_color_map: dict[EffectCharacter, Color] = {}
    self.build()

__next__()

Return the next frame in the animation.

Source code in terminaltexteffects/effects/effect_overflow.py 
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
def __next__(self) -> str:
    """Return the next frame in the animation."""
    if self.pending_rows:
        if not self._delay:
            for _ in range(random.randint(1, self.config.overflow_speed)):
                if self.pending_rows:
                    for row in self.active_rows:
                        row.move_up()
                        if not row.final:
                            row.set_color(
                                self._overflow_gradient.spectrum[
                                    min(
                                        row.characters[0].motion.current_coord.row,
                                        len(self._overflow_gradient.spectrum) - 1,
                                    )
                                ],
                            )
                    next_row = self.pending_rows.pop(0)
                    next_row.setup()
                    next_row.move_up()
                    if not next_row.final:
                        next_row.set_color(self._overflow_gradient.spectrum[0])
                    for character in next_row.characters:
                        self.terminal.set_character_visibility(character, is_visible=True)
                    self.active_rows.append(next_row)
            self._delay = random.randint(0, 3)

        else:
            self._delay -= 1
        self.active_rows = [
            row
            for row in self.active_rows
            if row.characters[0].motion.current_coord.row <= self.terminal.canvas.top
        ]
        self.update()
        return self.frame
    raise StopIteration

build()

Build the initial state of the effect.

Source code in terminaltexteffects/effects/effect_overflow.py 
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
def build(self) -> None:
    """Build the initial state of the effect."""
    final_gradient = Gradient(*self.config.final_gradient_stops, steps=self.config.final_gradient_steps)
    final_gradient_mapping = 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):
        self.character_final_color_map[character] = final_gradient_mapping.get(
            character.input_coord,
            Color("000000"),
        )
    lower_range, upper_range = self.config.overflow_cycles_range
    rows = self.terminal.get_characters_grouped(Terminal.CharacterGroup.ROW_TOP_TO_BOTTOM)
    if upper_range > 0:
        for _ in range(random.randint(lower_range, upper_range)):
            random.shuffle(rows)
            for row in rows:
                copied_characters = []
                # copy the character attributes to new characters
                for character in row:
                    character_copy = self.terminal.add_character(character.input_symbol, character.input_coord)
                    character_copy.animation.existing_color_handling = self.terminal.config.existing_color_handling
                    character_copy._input_ansi_sequences = character._input_ansi_sequences
                    character_copy.animation.no_color = character.animation.no_color
                    character_copy.animation.use_xterm_colors = character.animation.use_xterm_colors
                    character_copy.animation.input_fg_color = character.animation.input_fg_color
                    character_copy.animation.input_bg_color = character.animation.input_bg_color
                    copied_characters.append(character_copy)
                self.pending_rows.append(OverflowIterator.Row(copied_characters))
    # add rows in correct order to the end of self.pending_rows
    for row in self.terminal.get_characters_grouped(
        Terminal.CharacterGroup.ROW_TOP_TO_BOTTOM,
        outer_fill_chars=True,
        inner_fill_chars=True,
    ):
        next_row = OverflowIterator.Row(row)
        for character in next_row.characters:
            if self.terminal.config.existing_color_handling == "dynamic" and any(
                (character.animation.input_fg_color, character.animation.input_bg_color),
            ):
                character.animation.set_appearance(
                    character.animation.current_character_visual.symbol,
                    ColorPair(
                        fg=character.animation.input_fg_color,
                        bg=character.animation.input_bg_color,
                    ),
                )
            else:
                character.animation.set_appearance(
                    character.animation.current_character_visual.symbol,
                    ColorPair(fg=self.character_final_color_map[character]),
                )
        self.pending_rows.append(OverflowIterator.Row(row, final=True))
    self._delay = 0
    self._overflow_gradient = Gradient(
        *self.config.overflow_gradient_stops,
        steps=max((self.terminal.canvas.top // max(1, len(self.config.overflow_gradient_stops) - 1)), 1),
    )

get_effect_and_args()

Get the effect class and its configuration class.

Source code in terminaltexteffects/effects/effect_overflow.py 
21
22
23
def get_effect_and_args() -> tuple[type[typing.Any], type[ArgsDataClass]]:
    """Get the effect class and its configuration class."""
    return Overflow, OverflowConfig