Method remove

constructor/briefcase.py:404–418

Remove the root of the payload. This function requires some extra care due to the root directory being a cached property.

(self, *, ignore_errors: bool = True)

        return Path(tempfile.mkdtemp(prefix="payload-"))

    def remove(self, *, ignore_errors: bool = True) -> None:
        """Remove the root of the payload.

        This function requires some extra care due to the root directory being a cached property.
        """
        root = getattr(self, "root", None)
        if root is None:
            return
        shutil.rmtree(root, ignore_errors=ignore_errors)
        # Now we drop the cached value so next access will recreate if desired
        try:
            delattr(self, "root")
        except Exception:
            # delattr on a cached_property may raise on some versions / edge cases
            pass

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