kiwi.iso_tools Package

Submodules

kiwi.iso_tools.base Module

class kiwi.iso_tools.base.IsoToolsBase(source_dir: str)

Bases: object

Base Class for Parameter API for iso creation tools

add_efi_loader_parameters(loader_file: str) → None

Add ISO creation parameters to embed the EFI loader

Implementation in specialized tool class

create_iso(filename: str, hidden_files: List[str] | None = None) → None

Create iso file

Implementation in specialized tool class

Parameters:

• filename (str) – unused

• hidden_files (list) – unused

get_tool_name() → str

Return caller name for iso creation tool

Implementation in specialized tool class

Returns:

tool name

Return type:

str

has_iso_hybrid_capability() → bool

Indicate if the iso tool has the capability to embed a partition table into the iso such that it can be used as both; an iso and a disk

Implementation in specialized tool class

init_iso_creation_parameters(custom_args: Dict[str, str | bool] | None = None) → None

Create a set of standard parameters for the main loader

Implementation in specialized tool class

Parameters:

custom_args (list) – unused

list_iso(isofile: str) → None

List contents of an ISO image

Parameters:

isofile (str) – unused

static setup_media_loader_directory(lookup_path: str, media_path: str, boot_theme: str)

kiwi.iso_tools.xorriso Module

class kiwi.iso_tools.xorriso.IsoToolsXorrIso(source_dir: str)

Bases: IsoToolsBase

xorriso wrapper class

Implementation of Parameter API for iso creation tools using the libburnia project. Addressed here is the tool xorriso

add_efi_loader_parameters(loader_file: str) → None

Add ISO creation parameters to embed the EFI loader

In order to boot the ISO from EFI, the EFI binary is added as alternative loader to the ISO creation parameter list. The EFI binary must be included into a fat filesystem in order to become recognized by the firmware. For details about this file refer to _create_embedded_fat_efi_image() from bootloader/config/grub2.py

create_iso(filename: str, hidden_files: List[str] | None = None) → None

Creates the iso file with the given filename using xorriso

Parameters:

• filename (str) – output filename

• hidden_files (list) – list of hidden files

get_tool_name() → str

Lookup xorriso in search path

Raises:

KiwiIsoToolError – if xorriso tool is not found

Returns:

xorriso tool path

Return type:

str

has_iso_hybrid_capability() → bool

Indicate if the iso tool has the capability to embed a partition table into the iso such that it can be used as both; an iso and a disk

Returns:

True or False

Return type:

bool

init_iso_creation_parameters(custom_args: Dict[str, str | bool] | None = None) → None

Create a set of standard parameters

Parameters:

custom_args (list) – custom ISO meta data

kiwi.iso_tools.iso Module

class kiwi.iso_tools.iso.Iso(source_dir: str)

Bases: object

Implements helper methods around the creation of ISO filesystems

static set_media_tag(isofile: str) → None

Include checksum tag in the ISO so it can be verified with the mediacheck program.

Parameters:

isofile (str) – path to the ISO file

Module Contents

class kiwi.iso_tools.IsoTools

Bases: object

IsoTools factory

static new(source_dir: str) → Any