shell_events

• OutputCallbackT
• ShellRunAfter
• ShellRunBefore
• ShellRunCallbackT
• ShellRunPOpenStarted
• ShellRunRetryAttempt
• ShellRunStdOutput
• ShellRunStdReadError
• ShellRunStdStarted

Symbol Details

type_alias: OutputCallbackT

• source

  Since: 0.3.0

OutputCallbackT = typing.Callable[[str], bool | None]

Changes

Version	Change
0.3.0	Made public

class: ShellRunAfter

• source

  Since: 0.3.0

class ShellRunAfter:
    run: ShellRun
    error: BaseException | None = None

Field	Type	Default	Since
run	ShellRun	-	0.3.0
error	BaseException | None	None	0.3.0

Changes

Version	Change
0.3.0	Made public

class: ShellRunBefore

• source

  Since: 0.3.0

class ShellRunBefore:
    run: ShellRun

Field	Type	Default	Since
run	ShellRun	-	0.3.0

Changes

Version	Change
0.3.0	Made public

type_alias: ShellRunCallbackT

• source

  Since: 0.3.0

ShellRunCallbackT = typing.Callable[[typing.Union[ask_shell._internal.events.ShellRunBefore, ask_shell._internal.events.ShellRunPOpenStarted, ask_shell._internal.events.ShellRunStdStarted, ask_shell._internal.events.ShellRunStdReadError, ask_shell._internal.events.ShellRunStdOutput, ask_shell._internal.events.ShellRunRetryAttempt, ask_shell._internal.events.ShellRunAfter]], bool | None]

Changes

Version	Change
0.3.0	Made public

class: ShellRunPOpenStarted

• source

  Since: 0.3.0

class ShellRunPOpenStarted:
    p_open: Popen

Field	Type	Default	Since
p_open	Popen	-	0.3.0

Changes

Version	Change
0.3.0	Made public

class: ShellRunRetryAttempt

• source

  Since: 0.3.0

class ShellRunRetryAttempt:
    attempt: int

Field	Type	Default	Since
attempt	int	-	0.3.0

Changes

Version	Change
0.3.0	Made public

class: ShellRunStdOutput

• source

  Since: 0.3.0

class ShellRunStdOutput:
    is_stdout: bool
    content: str

Field	Type	Default	Since
is_stdout	bool	-	0.3.0
content	str	-	0.3.0

Changes

Version	Change
0.3.0	Made public

class: ShellRunStdReadError

• source

  Since: 0.3.0

class ShellRunStdReadError:
    is_stdout: bool
    error: BaseException

Field	Type	Default	Since
is_stdout	bool	-	0.3.0
error	BaseException	-	0.3.0

Changes

Version	Change
0.3.0	Made public

class: ShellRunStdStarted

• source

  Since: 0.3.0

class ShellRunStdStarted:
    is_stdout: bool
    console: Console
    log_path: Path

Field	Type	Default	Since
is_stdout	bool	-	0.3.0
console	Console	-	0.3.0
log_path	Path	-	0.3.0

Changes

Version	Change
0.3.0	Made public