Method make_archive

constructor/briefcase.py:461–487

Create an archive of the directory 'src'. The input 'src' must be an existing directory. If 'dst' does not exist, this function will create it. The directory specified via 'src' is removed after successful creation. Returns the path to the archive. Example:

(self, src: Path, dst: Path)

            raise RuntimeError(f"Unexpected error, failed to create archive: {archive_path}")

    def make_archive(self, src: Path, dst: Path) -> Path:
        """Create an archive of the directory 'src'.
        The input 'src' must be an existing directory.
        If 'dst' does not exist, this function will create it.
        The directory specified via 'src' is removed after successful creation.
        Returns the path to the archive.

        Example:
            payload = Payload(...)
            foo = Path('foo')
            bar = Path('bar')
            targz = payload.make_archive(foo, bar)
            This will create the file bar\\<payload.archive_name> containing 'foo' and all its contents.

        """
        if not src.is_dir():
            raise NotADirectoryError(src)
        dst.mkdir(parents=True, exist_ok=True)

        archive_path = dst / self.archive_name

        archive_type = archive_path.suffix[1:]  # since suffix starts with '.'
        with tarfile.open(archive_path, mode=f"w:{archive_type}", compresslevel=1) as tar:
            tar.add(src, arcname=src.name)

        shutil.rmtree(src)
        return archive_path

    def render_templates(self) -> list[Path]:
        """Render the configured templates under the payload root,