Class BundledProgram

devtools/bundled_program/core.py:33–395

Bundled program contains all information needed to execute and verify the program on device. Public Attributes: method_test_suites: All test suites for verifying methods. executorch_program: ExecutorchProgram-like variable, containing the Program to be verified by method_te

class BundledProgram:
    """
    Bundled program contains all information needed to execute and verify the program on device.

    Public Attributes:
        method_test_suites: All test suites for verifying methods.
        executorch_program: ExecutorchProgram-like variable, containing the Program to be verified by method_test_suites, including
                            ExecutorchProgram, MultiMethodExecutorchProgram or ExecutorchProgramManager.
    """

    def __init__(
        self,
        executorch_program: Optional[
            Union[
                ExecutorchProgram,
                ExecutorchProgramManager,
            ]
        ],
        method_test_suites: Sequence[MethodTestSuite],
        pte_file_path: Optional[str] = None,
    ):
        """Create BundledProgram by bundling the given program and method_test_suites together.

        Args:
            executorch_program: The program to be bundled.
            method_test_suites: The testcases for certain methods to be bundled.
            pte_file_path: The path to pte file to deserialize program if executorch_program is not provided.
        """
        if not executorch_program and not pte_file_path:
            raise RuntimeError(
                "Either executorch_program or pte_file_path must be provided"
            )

        if executorch_program and pte_file_path:
            raise RuntimeError(
                "Only one of executorch_program or pte_file_path can be used"
            )

        method_test_suites = sorted(method_test_suites, key=lambda x: x.method_name)
        if executorch_program:
            self._assert_valid_bundle(executorch_program, method_test_suites)
        self.executorch_program: Optional[
            Union[
                ExecutorchProgram,
                ExecutorchProgramManager,
            ]
        ] = executorch_program
        self._pte_file_path: Optional[str] = pte_file_path

        self.method_test_suites = method_test_suites

        # This is the cache for bundled program in schema type.
        # User should not access this field directly. Please Use `serialize_to_schema` function instead.
        self._bundled_program_in_schema: Optional[bp_schema.BundledProgram] = None

    def serialize_to_schema(self) -> bp_schema.BundledProgram:
        """Serialize the current Bundled Program into its schema format for further serialization.."""
        # Return cached value if exists