Method save

devtools/etrecord/_etrecord.py:138–175

Serialize and save the ETRecord to the specified path for use in Inspector. The ETRecord should contains at least edge dialect program and executorch program information for further analysis, otherwise it will raise an exception. Args: path: Path where t

(self, path: Union[str, os.PathLike, BinaryIO, IO[bytes]])

        self.__debug_handle_map = value

    def save(self, path: Union[str, os.PathLike, BinaryIO, IO[bytes]]) -> None:
        """
        Serialize and save the ETRecord to the specified path for use in Inspector. The ETRecord
        should contains at least edge dialect program and executorch program information for further
        analysis, otherwise it will raise an exception.

        Args:
            path: Path where the ETRecord file will be saved to.

        Raises:
            RuntimeError: If the ETRecord does not contain essential information for Inpector.
        """
        if isinstance(path, (str, os.PathLike)):
            # pyre-ignore[6]: In call `os.fspath`, for 1st positional argument, expected `str` but got `Union[PathLike[typing.Any], str]`
            path = os.fspath(path)

        if not (self.edge_dialect_program and self._debug_handle_map):
            raise RuntimeError(
                "ETRecord must contain edge dialect program and executorch program to be saved"
            )

        # Normalize edge_dialect_program to dict format for consistent handling
        if isinstance(self.edge_dialect_program, ExportedProgram):
            self._edge_dialect_programs_dict: Dict[str, ExportedProgram] = {
                "forward": self.edge_dialect_program
            }
        else:
            self._edge_dialect_programs_dict = self.edge_dialect_program

        etrecord_zip = ZipFile(path, "w")

        try:
            self._write_identifier(etrecord_zip)
            self._save_programs(etrecord_zip)
            self._save_graph_map(etrecord_zip)
            self._save_metadata(etrecord_zip)
        finally:
            etrecord_zip.close()

    def _write_identifier(self, etrecord_zip: ZipFile) -> None:
        """Write the magic file identifier."""