ask-shell 0.6.0__tar.gz → 0.7.0__tar.gz

{ask_shell-0.6.0 → ask_shell-0.7.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ask-shell
-Version: 0.6.0
+Version: 0.7.0
 Summary: CLIs with prompts, shell runs, and testable flows
 Author-email: EspenAlbert <espen.albert1@gmail.com>
 License-Expression: MIT

{ask_shell-0.6.0 → ask_shell-0.7.0}/ask_shell/__init__.py

@@ -5,12 +5,14 @@ from ask_shell import console
 from ask_shell import shell_events
 from ask_shell import ask
 from ask_shell.settings import AskShellSettings
+from ask_shell.settings import ShellRunSummary
 
-VERSION = "0.6.0"
+VERSION = "0.7.0"
 __all__ = [
     "shell",
     "console",
     "shell_events",
     "ask",
     "AskShellSettings",
+    "ShellRunSummary",
 ]

{ask_shell-0.6.0 → ask_shell-0.7.0}/ask_shell/_internal/_run.py

@@ -484,6 +484,7 @@ def run(
     start_timeout: float | None = None,
     terminal_width: int | None = None,
     skip_interactive_check: bool | None = None,
+    mute_shell_summary: bool | None = None,
 ) -> ShellRun:
     config = _as_config(
         config,
@@ -510,6 +511,7 @@ def run(
         skip_os_env=skip_os_env,
         terminal_width=terminal_width,
         skip_interactive_check=skip_interactive_check,
+        mute_shell_summary=mute_shell_summary,
     )
     assert not config.user_input, (
         "run() does not support user_input (only 1 should be active at a time), use run_and_wait() instead"
@@ -549,6 +551,7 @@ def run_and_wait(
     user_input: bool | None = None,
     terminal_width: int | None = None,
     skip_interactive_check: bool | None = None,
+    mute_shell_summary: bool | None = None,
 ) -> ShellRun:
     config = _as_config(
         script,
@@ -576,6 +579,7 @@ def run_and_wait(
         terminal_width=terminal_width,
         skip_interactive_check=skip_interactive_check,
         skip_progress_output=skip_progress_output,
+        mute_shell_summary=mute_shell_summary,
     )
     run = ShellRun(config)
     future = _pool.submit(_execute_run, run)

{ask_shell-0.6.0 → ask_shell-0.7.0}/ask_shell/_internal/models.py

@@ -172,6 +172,9 @@ class ShellConfig(Entity):
         default=False,
         description="Skip transitive std out/err output, useful for large outputs that are not needed in the logs when running parallel scripts",
     )
+    mute_shell_summary: bool = Field(
+        default=False, description="Skip shell summary logging useful when you want to ✅ or ❌ in the logs"
+    )
     terminal_width: int | None = 999
 
     # advanced settings

{ask_shell-0.6.0 → ask_shell-0.7.0}/ask_shell/_internal/rich_progress.py

@@ -47,10 +47,16 @@ def log_task_done(
     error: BaseException | None = None,
     description_override: str | None = None,
     extra_parts: list[str] | None = None,
+    soft_failure: bool = False,
 ):
     exit_comji = "❌" if force_error or error is not None else "✅"
     description = description_override or task.description
-    log_call = logger.info if exit_comji == "✅" else logger.error
+    if exit_comji == "✅":
+        log_call = logger.info
+    elif soft_failure:
+        log_call = logger.warning
+    else:
+        log_call = logger.error
     message_parts = [f"{exit_comji} {description}"]
     if rich_task := task._rich_task:
         if finish_time := rich_task.finished_time:

{ask_shell-0.6.0 → ask_shell-0.7.0}/ask_shell/_internal/rich_run_state.py

@@ -21,6 +21,7 @@ from ask_shell._internal.models import (
     ShellRunEventT,
 )
 from ask_shell._internal.rich_progress import ProgressManager, log_task_done, new_task
+from ask_shell.settings import ShellRunSummary
 
 
 def _deque_default() -> deque[str]:
@@ -144,6 +145,10 @@ class _RunState:
             task.update(stderr=run_info.stderr_str)
         task.__exit__(None, None, None)
         run = run_info.run
+        if run.config.mute_shell_summary:
+            return
+        if run.config.settings.shell_run_summary == ShellRunSummary.ERRORS_ONLY and run.clean_complete:
+            return
         log_task_done(
             task,
             force_error=not run.clean_complete,
@@ -151,4 +156,5 @@ class _RunState:
             extra_parts=[
                 "" if run.current_attempt == 1 else f"attempt {run.current_attempt}",
             ],
+            soft_failure=run.config.allow_non_zero_exit and not run.clean_complete,
         )

{ask_shell-0.6.0 → ask_shell-0.7.0}/ask_shell/settings.py

@@ -1,6 +1,7 @@
 import logging
 import os
 from datetime import datetime, timedelta
+from enum import StrEnum
 from functools import cached_property, lru_cache
 from pathlib import Path
 from pydoc import locate
@@ -90,6 +91,11 @@ LogLevelIgnoredCase: TypeAlias = Annotated[
 ]
 
 
+class ShellRunSummary(StrEnum):
+    ALL = "all"
+    ERRORS_ONLY = "errors_only"
+
+
 class AskShellSettings(StaticSettings):
     model_config = ConfigDict(populate_by_name=True)  # type: ignore
     log_level: LogLevelIgnoredCase = "UNSET"
@@ -136,6 +142,11 @@ class AskShellSettings(StaticSettings):
         description="Runs once If `run_logs_dir` is not set. Can be 'yesterday' or a date string like '2023-01-01'. Will clean all logs up until the specified date but not that date itself.",
         alias=f"{ENV_PREFIX}RUN_LOGS_CLEAN",
     )
+    ENV_NAME_SHELL_RUN_SUMMARY: ClassVar[str] = f"{ENV_PREFIX}SHELL_RUN_SUMMARY"
+    shell_run_summary: ShellRunSummary = Field(
+        default=ShellRunSummary.ALL,
+        alias=ENV_NAME_SHELL_RUN_SUMMARY,
+    )
 
     @model_validator(mode="after")
     def ensure_vars_set(self) -> Self:

{ask_shell-0.6.0 → ask_shell-0.7.0}/pyproject.toml

@@ -2,7 +2,7 @@
 
 [project]
 name = "ask-shell"
-version = "0.6.0"
+version = "0.7.0"
 description = "CLIs with prompts, shell runs, and testable flows"
 requires-python = ">=3.13"
 license = "MIT"