picurv_cli.core.CommandExecutionError Class Reference

Raised when an external command exits unsuccessfully. More...

Inheritance diagram for picurv_cli.core.CommandExecutionError:

Collaboration diagram for picurv_cli.core.CommandExecutionError:

Public Member Functions
	__init__ (self, list command, int returncode, str details=None)
	Initialize a command execution error.

Data Fields
	command
	returncode
	details

Detailed Description

Raised when an external command exits unsuccessfully.

Definition at line 13292 of file core.py.

Constructor & Destructor Documentation

__init__()

picurv_cli.core.CommandExecutionError.__init__	(		self,
		list	command,
		int	returncode,
		str	details = None
	)

Initialize a command execution error.

Parameters

[in]	command	Argument passed to __init__().
[in]	returncode	Argument passed to __init__().
[in]	details	Argument passed to __init__().

Definition at line 13297 of file core.py.

    def __init__(self, command: list, returncode: int, details: str = None):
        """!
        @brief Initialize a command execution error.
        @param[in] command Argument passed to `__init__()`.
        @param[in] returncode Argument passed to `__init__()`.
        @param[in] details Argument passed to `__init__()`.
        """
        self.command = command
        self.returncode = returncode
        self.details = details
        detail_suffix = f": {details}" if details else ""
        super().__init__(
            f"Command failed with exit code {returncode}: {format_command_for_display(command)}{detail_suffix}"
        )
 
 

Field Documentation

command

picurv_cli.core.CommandExecutionError.command

Definition at line 13304 of file core.py.

returncode

picurv_cli.core.CommandExecutionError.returncode

Definition at line 13305 of file core.py.

details

picurv_cli.core.CommandExecutionError.details

Definition at line 13306 of file core.py.

---

The documentation for this class was generated from the following file:

• core.py