run

function: run

• source

  Since: 0.3.0

def run(
    config: ShellConfig | str,
    *,
    allow_non_zero_exit: bool | None = None,
    ansi_content: bool | None = None,
    attempts: int | None = None,
    cwd: str | Path | None = None,
    env: dict[str, str] | None = None,
    extra_popen_kwargs: dict | None = None,
    is_binary_call: bool | None = None,
    message_callbacks: list[
        Callable[
            [
                ShellRunBefore
                | ShellRunPOpenStarted
                | ShellRunStdStarted
                | ShellRunStdReadError
                | ShellRunStdOutput
                | ShellRunRetryAttempt
                | ShellRunAfter
            ],
            bool | None,
        ]
    ]
    | None = None,
    print_prefix: str | None = None,
    retry_initial_wait: float | None = None,
    retry_jitter: float | None = None,
    retry_max_wait: float | None = None,
    run_log_stem_prefix: str | None = None,
    run_output_dir: Path | None = None,
    settings: AskShellSettings | None = None,
    should_retry: Callable[[ShellRun], bool] | None = None,
    skip_binary_check: bool | None = None,
    skip_html_log_files: bool | None = None,
    skip_progress_output: bool | None = None,
    include_log_time: bool | None = None,
    skip_os_env: bool | None = None,
    start_timeout: float | None = None,
    terminal_width: int | None = None,
    skip_interactive_check: bool | None = None,
    mute_shell_summary: bool | None = None,
) -> ShellRun: ...

Changes

Version	Change
0.8.0	param 'message_callbacks' type: list[Callable[[ShellRunBefore
0.7.0	added optional param 'mute_shell_summary' (default: None)
0.5.1	added optional param 'retry_max_wait' (default: None)
0.5.1	added optional param 'retry_jitter' (default: None)
0.5.1	added optional param 'retry_initial_wait' (default: None)
0.4.0	param 'message_callbacks' type: list[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]]
0.3.0	Made public