Method save_to_csv

scenedetect/stats_manager.py:164–203

Save To CSV: Saves all frame metrics stored in the StatsManager to a CSV file. Arguments: csv_file: A file handle opened in write mode (e.g. open('...', 'w')) or a path as str. force_save: If True, writes metrics out even if an update is not required. Raises

(
        self,
        csv_file: StrPath | ty.TextIO,
        force_save=True,
    )

        return self._metrics_updated

    def save_to_csv(
        self,
        csv_file: StrPath | ty.TextIO,
        force_save=True,
    ) -> None:
        """Save To CSV: Saves all frame metrics stored in the StatsManager to a CSV file.

        Arguments:
            csv_file: A file handle opened in write mode (e.g. open('...', 'w')) or a path as str.
            force_save: If True, writes metrics out even if an update is not required.

        Raises:
            OSError: If `path` cannot be opened or a write failure occurs.
        """
        if not (force_save or self.is_save_required()):
            logger.info("No metrics to write.")
            return

        # If we get a path instead of an open file handle, recursively call ourselves
        # again but with file handle instead of path.
        if isinstance(csv_file, (str, bytes, Path, os.PathLike)):
            with open(csv_file, "w") as file:
                self.save_to_csv(csv_file=file, force_save=force_save)
                return
        # csv_file is now narrowed to ty.TextIO (the path branch returned above).

        csv_writer = csv.writer(csv_file, lineterminator="\n")
        metric_keys = sorted(list(self._metric_keys))
        csv_writer.writerow([COLUMN_NAME_FRAME_NUMBER, COLUMN_NAME_TIMECODE, *metric_keys])
        frame_keys = sorted(self._frame_metrics.keys())
        logger.info("Writing %d frames to CSV...", len(frame_keys))
        for frame_key in frame_keys:
            # `frame_key` may be a bare `int` if the deprecated `load_from_csv` populated the dict.
            # Skip such rows since we cannot recover a timecode without a base framerate.
            if not isinstance(frame_key, FrameTimecode):
                continue
            csv_writer.writerow(
                [frame_key.frame_num + 1, frame_key.get_timecode()]
                + [str(metric) for metric in self.get_metrics(frame_key, metric_keys)]
            )

    @staticmethod
    def valid_header(row: list[str]) -> bool: