Method prepare

constructor/briefcase.py:420–459

Prepares the payload. Directory structure created during preparation: / (temporary directory, see :attr:`root`) ├── welcome.bmp, header.bmp, icon.ico (branding images for WiX UI, not installed) └── /

(self)

            pass

    def prepare(self) -> None:
        """Prepares the payload.

        Directory structure created during preparation:

            <root>/                          (temporary directory, see :attr:`root`)
            ├── welcome.bmp, header.bmp, icon.ico  (branding images for WiX UI, not installed)
            └── <EXTERNAL_PACKAGE_PATH>/     (external_dir: contains the payload archive and conda exe)
                └── base/                    (base_dir: represents the base conda environment)
                    └── pkgs/                (pkgs_dir: staging area for conda package distributions)

        Note: base_dir and pkgs_dir are removed after archiving.
        """
        external_dir = self.root / EXTERNAL_PACKAGE_PATH
        external_dir.mkdir(parents=True, exist_ok=True)

        write_images(self.info, self.root, installer_type="msi")

        # Note that the directory name "base" is also explicitly defined in `run_installation.bat`
        base_dir = external_dir / "base"
        base_dir.mkdir()

        pkgs_dir = base_dir / "pkgs"
        pkgs_dir.mkdir()

        self.render_templates()
        self.write_pyproject_toml(self.root, external_dir)

        preconda.write_files(self.info, base_dir)
        preconda.copy_extra_files(self.info.get("extra_files", []), base_dir)
        # Copy license file to PREFIX, matching behavior of other installer types
        if license_file := self.info.get("license_file"):
            preconda.copy_extra_files([license_file], base_dir)
        self._stage_dists(pkgs_dir)
        self._stage_user_scripts(pkgs_dir)
        self._stage_conda(external_dir)

        archive_path = self.make_archive(base_dir, external_dir)
        if not archive_path.exists():
            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'.