craft_parts.ctl module

Helpers to invoke step execution handlers from the command line.

class craft_parts.ctl.CraftCtl[source]

Bases: object

Client for the craft-parts ctl protocol.

Craftctl is used to execute built-in step handlers and to get and set variables in the running part’s processor context.

classmethod run(cmd, args)[source]

Handle craftctl commands.

Parameters:
  • cmd (str) – The command to handle.

  • args (list[str]) – Command arguments.

Raises:

RuntimeError – If the command is not handled.

Return type:

str | None

craft_parts.ctl.main()[source]

Run the ctl client cli.

Return type:

None