progress_handler

Module that holds the ProgressHandler class and Song Tracker class.

`ProgressHandler(simple_tui=False, update_callback=None, web_ui=False)` ¤

Class for handling the progress of a download, including the progress bar.

Arguments¤

simple_tui: Whether or not to use the simple TUI.
update_callback: A callback to call when the progress bar is updated.

Source code in spotdl/download/progress_handler.py

def __init__(
    self,
    simple_tui: bool = False,
    update_callback: Optional[Callable[[Any, str], None]] = None,
    web_ui: bool = False,
):
    """
    Initialize the progress handler.

    ### Arguments
    - simple_tui: Whether or not to use the simple TUI.
    - update_callback: A callback to call when the progress bar is updated.
    """

    self.songs: List[Song] = []
    self.song_count: int = 0
    self.overall_progress = 0
    self.overall_total = 100
    self.overall_completed_tasks = 0
    self.update_callback = update_callback
    self.previous_overall = self.overall_completed_tasks

    self.simple_tui = simple_tui
    self.web_ui = web_ui
    self.quiet = logger.getEffectiveLevel() < 10
    self.overall_task_id: Optional[TaskID] = None

    if not self.simple_tui:
        console = get_console()

        self.rich_progress_bar = Progress(
            SizedTextColumn(
                "[white]{task.description}",
                overflow="ellipsis",
                width=int(console.width / 3),
            ),
            SizedTextColumn(
                "{task.fields[message]}", width=18, style="nonimportant"
            ),
            BarColumn(bar_width=None, finished_style="green"),
            "[progress.percentage]{task.percentage:>3.0f}%",
            TimeRemainingColumn(),
            # Normally when you exit the progress context manager (or call stop())
            # the last refreshed display remains in the terminal with the cursor on
            # the following line. You can also make the progress display disappear on
            # exit by setting transient=True on the Progress constructor
            transient=True,
        )

        # Basically a wrapper for rich's: with ... as ...
        self.rich_progress_bar.__enter__()

`add_song(song)` ¤

Adds a song to the list of songs.

Arguments¤

song: The song to add.

Source code in spotdl/download/progress_handler.py

def add_song(self, song: Song) -> None:
    """
    Adds a song to the list of songs.

    ### Arguments
    - song: The song to add.
    """

    self.songs.append(song)
    self.set_song_count(len(self.songs))

`close()` ¤

Close the Tui Progress Handler.

Source code in spotdl/download/progress_handler.py

def close(self) -> None:
    """
    Close the Tui Progress Handler.
    """

    if not self.simple_tui:
        self.rich_progress_bar.stop()

    logging.shutdown()

`get_new_tracker(song)` ¤

Get a new progress tracker.

Arguments¤

song: The song to track.

Returns¤

A new progress tracker.

Source code in spotdl/download/progress_handler.py

def get_new_tracker(self, song: Song) -> "SongTracker":
    """
    Get a new progress tracker.

    ### Arguments
    - song: The song to track.

    ### Returns
    - A new progress tracker.
    """

    return SongTracker(self, song)

`set_song_count(count)` ¤

Set the number of songs to download.

Arguments¤

count: The number of songs to download.

Source code in spotdl/download/progress_handler.py

def set_song_count(self, count: int) -> None:
    """
    Set the number of songs to download.

    ### Arguments
    - count: The number of songs to download.
    """

    self.song_count = count
    self.overall_total = 100 * count

    if not self.simple_tui:
        if self.song_count > 4:
            self.overall_task_id = self.rich_progress_bar.add_task(
                description="Total",
                message=(
                    f"{self.overall_completed_tasks}/{int(self.overall_total / 100)} "
                    "complete"
                ),
                total=self.overall_total,
                visible=(not self.quiet),
            )

`set_songs(songs)` ¤

Sets the list of songs to be downloaded.

Arguments¤

songs: The list of songs to download.

Source code in spotdl/download/progress_handler.py

def set_songs(self, songs: List[Song]) -> None:
    """
    Sets the list of songs to be downloaded.

    ### Arguments
    - songs: The list of songs to download.
    """

    self.songs = songs
    self.set_song_count(len(songs))

`update_overall()` ¤

Update the overall progress bar.

Source code in spotdl/download/progress_handler.py

def update_overall(self) -> None:
    """
    Update the overall progress bar.
    """

    if not self.simple_tui:
        # If the overall progress bar exists
        if self.overall_task_id is not None:
            self.rich_progress_bar.update(
                self.overall_task_id,
                message=f"{self.overall_completed_tasks}/"
                f"{int(self.overall_total / 100)} "
                "complete",
                completed=self.overall_progress,
            )
    else:
        if self.previous_overall != self.overall_completed_tasks:
            logger.info(
                "%s/%s complete", self.overall_completed_tasks, self.song_count
            )
            self.previous_overall = self.overall_completed_tasks