labtasker 0.2.4__tar.gz → 0.2.6__tar.gz

{labtasker-0.2.4 → labtasker-0.2.6}/.coveragerc

@@ -2,3 +2,4 @@
 omit =
 # skip those auto-generated codes by antlr
     labtasker/client/core/cmd_parser/generated
+    labtasker/vendor/*

{labtasker-0.2.4 → labtasker-0.2.6}/.flake8

@@ -11,7 +11,8 @@ exclude =
     .tox,
     .mypy_cache,
     .pytest_cache,
-    labtasker/client/core/cmd_parser/generated
+    labtasker/client/core/cmd_parser/generated,
+    labtasker/vendor
 per-file-ignores =
     __init__.py:F401,F403
     tests/*:F841,F811,F401,S101

{labtasker-0.2.4 → labtasker-0.2.6}/.gitmodules

@@ -1,8 +1,8 @@
 [submodule "plugins/labtasker_plugin_task_count"]
 	path = plugins/labtasker_plugin_task_count
-	url = https://github.com/fkcptlst/labtasker-plugin-task-count.git
+	url = https://github.com/luocfprime/labtasker-plugin-task-count.git
 	branch = main
 [submodule "plugins/labtasker_plugin_script_generate"]
 	path = plugins/labtasker_plugin_script_generate
-	url = https://github.com/fkcptlst/labtasker-plugin-script-generate.git
+	url = https://github.com/luocfprime/labtasker-plugin-script-generate.git
 	branch = main

{labtasker-0.2.4 → labtasker-0.2.6}/.pre-commit-config.yaml

@@ -1,3 +1,5 @@
+exclude: ^labtasker/vendor/|^labtasker/client/core/cmd_parser/generated
+
 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
     rev: v5.0.0

{labtasker-0.2.4 → labtasker-0.2.6}/PKG-INFO

@@ -1,12 +1,12 @@
 Metadata-Version: 2.4
 Name: labtasker
-Version: 0.2.4
+Version: 0.2.6
 Summary: A task queue system for lab experiments
 Author-email: Your Name <your.email@example.com>
 License: Apache License 2.0
-Project-URL: Homepage, https://github.com/fkcptlst/labtasker
-Project-URL: Documentation, https://fkcptlst.github.io/labtasker
-Project-URL: Repository, https://github.com/fkcptlst/labtasker.git
+Project-URL: Homepage, https://github.com/luocfprime/labtasker
+Project-URL: Documentation, https://luocfprime.github.io/labtasker
+Project-URL: Repository, https://github.com/luocfprime/labtasker.git
 Classifier: Intended Audience :: Science/Research
 Classifier: License :: OSI Approved :: Apache Software License
 Classifier: Operating System :: OS Independent
@@ -20,13 +20,11 @@ Classifier: Programming Language :: Python :: 3.13
 Requires-Python: <4.0,>=3.8.1
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: python-dotenv<2.0.0,>=1.0.1
 Requires-Dist: pymongo<5.0.0,>=4.0.0
 Requires-Dist: fastapi<0.116.0,>=0.115.0
 Requires-Dist: uvicorn[standard]<0.35.0,>=0.15.0
 Requires-Dist: click<9.0.0,>=8.1.0
 Requires-Dist: passlib<2.0.0,>=1.7.0
-Requires-Dist: antlr4-python3-runtime<5.0.0,>=4.13.0
 Requires-Dist: pydantic-settings<3.0.0,>=2.8.0
 Requires-Dist: httpx[socks]<0.29.0,>=0.28.0
 Requires-Dist: typer<0.16.0,>=0.15.0
@@ -43,6 +41,7 @@ Requires-Dist: noneprompt<0.2.0,>=0.1.9
 Requires-Dist: mongomock<4.4.0,>=4.3.0
 Requires-Dist: jsonpickle<5.0.0,>=4.0.2
 Requires-Dist: mslex<2.0.0,>=1.3.0
+Requires-Dist: pexpect<5.0.0,>=4.9.0
 Provides-Extra: dev
 Requires-Dist: pytest<9.0.0,>=8.0.0; extra == "dev"
 Requires-Dist: pytest-cov<7.0.0,>=5.0.0; extra == "dev"
@@ -69,11 +68,11 @@ Dynamic: license-file
 
 <p align="center"><em>Make your ML experiment wrapper scripts smarter with...</em></p>
 <h1 align="center" style="font-size: 40px;"> <a href="">Labtasker</a></h1>
-<p align="center"><a href="https://fkcptlst.github.io/labtasker/latest/install/install/">Install</a> • <a href="https://fkcptlst.github.io/labtasker/latest/guide/basic/">Tutorial / Demo</a> • <a href="https://fkcptlst.github.io/labtasker/latest/">Documentation</a> • <a href="https://fkcptlst.github.io/labtasker/latest/faq/">FAQs</a> • <a href="https://github.com/fkcptlst/labtasker/releases">Releases</a></p>
+<p align="center"><a href="https://luocfprime.github.io/labtasker/latest/install/install/">Install</a> • <a href="https://luocfprime.github.io/labtasker/latest/guide/basic/">Tutorial / Demo</a> • <a href="https://luocfprime.github.io/labtasker/latest/">Documentation</a> • <a href="https://luocfprime.github.io/labtasker/latest/faq/">FAQs</a> • <a href="https://github.com/luocfprime/labtasker/releases">Releases</a></p>
 
 <p align="center">
-  <img src="https://github.com/fkcptlst/labtasker/actions/workflows/unit-test-matrix.yml/badge.svg" alt="unit-test-matrix" />
-  <a href="https://codecov.io/gh/fkcptlst/labtasker"><img src="https://codecov.io/gh/fkcptlst/labtasker/graph/badge.svg?token=KQFBV3QRPY" alt="codecov" /></a>
+  <img src="https://github.com/luocfprime/labtasker/actions/workflows/unit-test-matrix.yml/badge.svg" alt="unit-test-matrix" />
+  <a href="https://codecov.io/gh/luocfprime/labtasker"><img src="https://codecov.io/gh/luocfprime/labtasker/graph/badge.svg?token=KQFBV3QRPY" alt="codecov" /></a>
   <img src="https://img.shields.io/badge/Python-3.8%20|%203.9%20|%203.10%20|%203.11%20|%203.12%20|%203.13-blue" alt="Python version" />
   <a href="https://pypi.org/project/labtasker/"><img src="https://img.shields.io/pypi/v/labtasker" alt="PyPI" /></a>
 </p>
@@ -91,7 +90,7 @@ parallelization, dynamic task prioritization, failure handling, halfway resume,
 
 ![comparison](docs/docs/assets/comparison.png)
 
-🐳 For detailed examples and concepts, check out the [documentation](https://fkcptlst.github.io/labtasker/).
+🐳 For detailed examples and concepts, check out the [documentation](https://luocfprime.github.io/labtasker/).
 
 ## 🧪️ A Quick Demo
 
@@ -103,7 +102,7 @@ such as sending emails on task failure.
 ![demo](docs/docs/assets/gifs/demo.gif)
 
 For more detailed steps, please refer to the content in
-the [Tutorial / Demo](https://fkcptlst.github.io/labtasker/latest/guide/basic/).
+the [Tutorial / Demo](https://luocfprime.github.io/labtasker/latest/guide/basic/).
 
 ## ⚡️ Features
 
@@ -133,7 +132,7 @@ the [Tutorial / Demo](https://fkcptlst.github.io/labtasker/latest/guide/basic/).
 > [!NOTE]
 > You need a running Labtasker server to use the client tools.
 > Simply use the installed Python CLI `labtasker-server serve` or use docker-compose to deploy the server.
-> See [deployment instructions](https://fkcptlst.github.io/labtasker/latest/install/deployment/).
+> See [deployment instructions](https://luocfprime.github.io/labtasker/latest/install/deployment/).
 
 ### 1. Install via PyPI
 
@@ -145,7 +144,7 @@ pip install 'labtasker[plugins]'
 ### 2. Install the Latest Version from GitHub
 
 ```bash
-pip install git+https://github.com/fkcptlst/labtasker.git
+pip install git+https://github.com/luocfprime/labtasker.git
 ```
 
 ## 🚀 Quick Start
@@ -165,13 +164,13 @@ labtasker init
 Then, use `labtasker submit` to submit tasks and use `labtasker loop` to run tasks across any number of workers.
 
 > [!TIP]
-> If you think manually writing 2 scripts for submit and run is laborious, you can checkout the [labtasker-plugin-script-generate](https://github.com/fkcptlst/labtasker-plugin-script-generate).
+> If you think manually writing 2 scripts for submit and run is laborious, you can checkout the [labtasker-plugin-script-generate](https://github.com/luocfprime/labtasker-plugin-script-generate).
 > It automatically generate 2 scripts based on the script you provided.
 
 ## 📚 Documentation
 
 For detailed information on demo, tutorial, deployment, usage, please refer to
-the [documentation](https://fkcptlst.github.io/labtasker/).
+the [documentation](https://luocfprime.github.io/labtasker/).
 
 ## 🔒 License
 

{labtasker-0.2.4 → labtasker-0.2.6}/README.md

@@ -1,10 +1,10 @@
 <p align="center"><em>Make your ML experiment wrapper scripts smarter with...</em></p>
 <h1 align="center" style="font-size: 40px;"> <a href="">Labtasker</a></h1>
-<p align="center"><a href="https://fkcptlst.github.io/labtasker/latest/install/install/">Install</a> • <a href="https://fkcptlst.github.io/labtasker/latest/guide/basic/">Tutorial / Demo</a> • <a href="https://fkcptlst.github.io/labtasker/latest/">Documentation</a> • <a href="https://fkcptlst.github.io/labtasker/latest/faq/">FAQs</a> • <a href="https://github.com/fkcptlst/labtasker/releases">Releases</a></p>
+<p align="center"><a href="https://luocfprime.github.io/labtasker/latest/install/install/">Install</a> • <a href="https://luocfprime.github.io/labtasker/latest/guide/basic/">Tutorial / Demo</a> • <a href="https://luocfprime.github.io/labtasker/latest/">Documentation</a> • <a href="https://luocfprime.github.io/labtasker/latest/faq/">FAQs</a> • <a href="https://github.com/luocfprime/labtasker/releases">Releases</a></p>
 
 <p align="center">
-  <img src="https://github.com/fkcptlst/labtasker/actions/workflows/unit-test-matrix.yml/badge.svg" alt="unit-test-matrix" />
-  <a href="https://codecov.io/gh/fkcptlst/labtasker"><img src="https://codecov.io/gh/fkcptlst/labtasker/graph/badge.svg?token=KQFBV3QRPY" alt="codecov" /></a>
+  <img src="https://github.com/luocfprime/labtasker/actions/workflows/unit-test-matrix.yml/badge.svg" alt="unit-test-matrix" />
+  <a href="https://codecov.io/gh/luocfprime/labtasker"><img src="https://codecov.io/gh/luocfprime/labtasker/graph/badge.svg?token=KQFBV3QRPY" alt="codecov" /></a>
   <img src="https://img.shields.io/badge/Python-3.8%20|%203.9%20|%203.10%20|%203.11%20|%203.12%20|%203.13-blue" alt="Python version" />
   <a href="https://pypi.org/project/labtasker/"><img src="https://img.shields.io/pypi/v/labtasker" alt="PyPI" /></a>
 </p>
@@ -22,7 +22,7 @@ parallelization, dynamic task prioritization, failure handling, halfway resume,
 
 ![comparison](docs/docs/assets/comparison.png)
 
-🐳 For detailed examples and concepts, check out the [documentation](https://fkcptlst.github.io/labtasker/).
+🐳 For detailed examples and concepts, check out the [documentation](https://luocfprime.github.io/labtasker/).
 
 ## 🧪️ A Quick Demo
 
@@ -34,7 +34,7 @@ such as sending emails on task failure.
 ![demo](docs/docs/assets/gifs/demo.gif)
 
 For more detailed steps, please refer to the content in
-the [Tutorial / Demo](https://fkcptlst.github.io/labtasker/latest/guide/basic/).
+the [Tutorial / Demo](https://luocfprime.github.io/labtasker/latest/guide/basic/).
 
 ## ⚡️ Features
 
@@ -64,7 +64,7 @@ the [Tutorial / Demo](https://fkcptlst.github.io/labtasker/latest/guide/basic/).
 > [!NOTE]
 > You need a running Labtasker server to use the client tools.
 > Simply use the installed Python CLI `labtasker-server serve` or use docker-compose to deploy the server.
-> See [deployment instructions](https://fkcptlst.github.io/labtasker/latest/install/deployment/).
+> See [deployment instructions](https://luocfprime.github.io/labtasker/latest/install/deployment/).
 
 ### 1. Install via PyPI
 
@@ -76,7 +76,7 @@ pip install 'labtasker[plugins]'
 ### 2. Install the Latest Version from GitHub
 
 ```bash
-pip install git+https://github.com/fkcptlst/labtasker.git
+pip install git+https://github.com/luocfprime/labtasker.git
 ```
 
 ## 🚀 Quick Start
@@ -96,13 +96,13 @@ labtasker init
 Then, use `labtasker submit` to submit tasks and use `labtasker loop` to run tasks across any number of workers.
 
 > [!TIP]
-> If you think manually writing 2 scripts for submit and run is laborious, you can checkout the [labtasker-plugin-script-generate](https://github.com/fkcptlst/labtasker-plugin-script-generate).
+> If you think manually writing 2 scripts for submit and run is laborious, you can checkout the [labtasker-plugin-script-generate](https://github.com/luocfprime/labtasker-plugin-script-generate).
 > It automatically generate 2 scripts based on the script you provided.
 
 ## 📚 Documentation
 
 For detailed information on demo, tutorial, deployment, usage, please refer to
-the [documentation](https://fkcptlst.github.io/labtasker/).
+the [documentation](https://luocfprime.github.io/labtasker/).
 
 ## 🔒 License
 

{labtasker-0.2.4 → labtasker-0.2.6}/docker-compose.yml

@@ -58,7 +58,7 @@ services:
       context: .
       dockerfile: Dockerfile
       network: host
-    image: ghcr.io/fkcptlst/labtasker-api
+    image: ghcr.io/luocfprime/labtasker-api
     container_name: labtasker-api
     environment:
       - DB_USER=${DB_USER}

{labtasker-0.2.4 → labtasker-0.2.6}/labtasker/__init__.py

@@ -1,4 +1,4 @@
-__version__ = "0.2.4"
+__version__ = "0.2.6"
 
 from labtasker.client.client_api import *
 from labtasker.client.core.config import get_client_config

labtasker-0.2.6/labtasker/client/cli/loop.py

@@ -0,0 +1,266 @@
+"""Implements `labtasker loop xxx`"""
+
+import json
+import os
+import subprocess
+import sys
+from collections import defaultdict
+from pathlib import Path
+from typing import List, Optional
+
+import pexpect
+import typer
+from typing_extensions import Annotated
+
+from labtasker.client.cli.cli import app
+from labtasker.client.core.cli_utils import (
+    cli_utils_decorator,
+    eta_max_validation,
+    parse_filter,
+)
+from labtasker.client.core.cmd_parser import cmd_interpolate
+from labtasker.client.core.config import get_client_config
+from labtasker.client.core.context import task_info
+from labtasker.client.core.exceptions import CmdParserError, _LabtaskerJobFailed
+from labtasker.client.core.job_runner import loop_run
+from labtasker.client.core.logging import (
+    logger,
+    set_verbose,
+    stderr_console,
+    verbose_print,
+)
+
+
+class InfiniteDefaultDict(defaultdict):
+
+    def __getitem__(self, key):
+        if key not in self:
+            self[key] = InfiniteDefaultDict()
+        return super().__getitem__(key)
+
+    def get(self, key, default=None):
+        if key not in self:
+            self[key] = InfiniteDefaultDict()
+        return super().get(key, default)
+
+
+def _check_pty_available(opt: bool) -> bool:
+    if opt and os.name == "nt":
+        stderr_console.print(
+            "[bold orange1]Warning:[/bold orange1] PTY is not available on Windows. "
+            "Disabling PTY support."
+        )
+        return False
+    return opt
+
+
+def _stream_child_output(child) -> None:
+    """Stream the output of a pexpect child in real-time, supporting progress bars."""
+    try:
+        while True:
+            try:
+                output = child.read_nonblocking(size=1024, timeout=0.1)
+                if output:
+                    # keep \r
+                    sys.stdout.write(output)
+                    sys.stdout.flush()
+            except pexpect.TIMEOUT:
+                continue
+            except pexpect.EOF:
+                break
+    finally:
+        child.close()
+
+
+def _run_with_pty(cmd, shell_exec=None, use_shell=False):
+    """Run a command with PTY support for interactive programs."""
+    if use_shell:
+        shell_exec = shell_exec or "/bin/sh"
+        child = pexpect.spawn(shell_exec, ["-c", cmd], encoding="utf-8")
+    else:
+        child = pexpect.spawn(cmd[0], cmd[1:], encoding="utf-8")
+
+    _stream_child_output(child)
+
+    return child.exitstatus
+
+
+def _run_with_subprocess(cmd, shell_exec=None, use_shell=False):
+    """Run a command using standard subprocess approach."""
+    with subprocess.Popen(
+        args=cmd,
+        stdin=subprocess.PIPE,
+        stdout=subprocess.PIPE,
+        stderr=subprocess.PIPE,
+        text=True,
+        executable=shell_exec,
+        shell=use_shell,
+    ) as process:
+        while True:
+            output = process.stdout.readline()
+            error = process.stderr.readline()
+
+            if output:
+                sys.stdout.write(output.strip())
+                sys.stdout.flush()
+            if error:
+                sys.stderr.write(error.strip())
+                sys.stderr.flush()
+
+            # Break when process completes and streams are empty
+            if process.poll() is not None and not output and not error:
+                break
+
+        return process.returncode
+
+
+@app.command()
+@cli_utils_decorator
+def loop(
+    cmd: Annotated[
+        List[str],
+        typer.Argument(
+            ...,
+            help="Command to run. Supports argument interpolation using %(arg_name) syntax. Example: `python main.py '%(input_file)' '%(output_dir)'`",
+        ),
+    ] = None,
+    option_cmd: str = typer.Option(
+        None,
+        "--command",
+        "--cmd",
+        "-c",
+        help="Specify the command to run with shell=True. Supports the same argument interpolation the same way as the positional argument. Except you need to quote the entire command.",
+    ),
+    script_path: Optional[Path] = typer.Option(
+        None,
+        exists=True,
+        readable=True,
+        help="Path to a script file that contains the command to execute. The script will run with '%(...)' placeholders replaced by the retrieved task arguments.",
+    ),
+    executable: Optional[str] = typer.Option(
+        None,
+        "--executable",
+        help="Specify the shell executable to run the command with.",
+    ),
+    extra_filter: Optional[str] = typer.Option(
+        None,
+        "--extra-filter",
+        "-f",
+        help='Filter tasks using MongoDB query syntax (e.g., \'{"metadata.tag": {"$in": ["a", "b"]}}\') or Python expression (e.g., \'metadata.tag in ["a", "b"] and priority == 10\').',
+    ),
+    worker_id: Optional[str] = typer.Option(
+        None,
+        help="Assign a specific worker ID to run the tasks under.",
+    ),
+    eta_max: Optional[str] = typer.Option(
+        None,
+        callback=eta_max_validation,
+        help="Maximum estimated time for task completion (e.g. '1h', '1h30m', '50s'). After which the task will be considered timed out.",
+    ),
+    heartbeat_timeout: Optional[float] = typer.Option(
+        None,
+        help="Time in seconds before a task is considered stalled if no heartbeat is received.",
+    ),
+    use_pty: bool = typer.Option(
+        os.name == "posix",  # enabled by default on POSIX systems
+        callback=_check_pty_available,
+        help="Use pseudo terminal on POSIX systems for better interactive program support.",
+    ),
+    verbose: bool = typer.Option(  # noqa
+        False,
+        "--verbose",
+        "-v",
+        help="Enable verbose output.",
+        callback=set_verbose,
+        is_eager=True,
+    ),
+):
+    """Process tasks from the queue by repeatedly running a command with task arguments.
+
+    The command uses template syntax to insert task arguments. For example:
+
+    labtasker loop -- python process.py --input '%(input_file)' --output '%(output_dir)'
+
+    This will fetch tasks with 'input_file' and 'output_dir' arguments and run the command
+    with those values substituted. Tasks are processed until the queue is empty.
+    """
+    # Ensure only one of [CMD], [--command], or [--script-path] is specified
+    cmd_sources = [cmd, option_cmd, script_path]
+    cmd_sources = list(filter(None, cmd_sources))  # Remove None values dynamically
+    if len(cmd_sources) > 1:
+        raise typer.BadParameter(
+            "Only one of [CMD], [--command], or [--script-path] can be specified. Choose one."
+        )
+
+    # 1. Assign from cmd or option_cmd
+    input_cmd = cmd or option_cmd
+
+    # 2. Assign from script_path if provided
+    if script_path and input_cmd is None:
+        with open(script_path, "r") as f:
+            input_cmd = f.read().strip()
+
+    # 3. Try reading from stdin if shell mode is enabled
+    if not input_cmd and not sys.stdin.isatty():
+        input_cmd = sys.stdin.read().strip()
+
+    # Final validation: ensure a command is present
+    if not input_cmd:
+        raise typer.BadParameter(
+            "Command cannot be empty. Specify via positional argument [CMD] or `--command` or `--script-path`."
+        )
+
+    parsed_filter = parse_filter(extra_filter)
+    verbose_print(f"Parsed filter: {json.dumps(parsed_filter, indent=4)}")
+
+    if heartbeat_timeout is None:
+        heartbeat_timeout = get_client_config().task.heartbeat_interval * 3
+
+    # Generate required fields dict
+    dummy_variable_table = InfiniteDefaultDict()
+    try:
+        _, queried_keys = cmd_interpolate(input_cmd, dummy_variable_table)
+    except (CmdParserError, KeyError, TypeError) as e:
+        raise typer.BadParameter(f"Command error with exception {e}")
+
+    required_fields = list(queried_keys)
+
+    logger.info(f"Got command: {input_cmd}")
+
+    @loop_run(
+        required_fields=required_fields,
+        extra_filter=parsed_filter,
+        worker_id=worker_id,
+        eta_max=eta_max,
+        heartbeat_timeout=heartbeat_timeout,
+        pass_args_dict=True,
+    )
+    def run_cmd(args):
+        interpolated_cmd, _ = cmd_interpolate(input_cmd, args)
+        logger.info(f"Prepared to run interpolated command: {interpolated_cmd}")
+
+        use_shell = isinstance(interpolated_cmd, str)
+
+        try:
+            if use_pty:
+                # Use pexpect with PTY on POSIX systems
+                exit_code = _run_with_pty(interpolated_cmd, executable, use_shell)
+            else:
+                # Standard subprocess approach for non-PTY execution
+                exit_code = _run_with_subprocess(
+                    interpolated_cmd, executable, use_shell
+                )
+
+            if exit_code != 0:
+                raise _LabtaskerJobFailed(
+                    f"Job process finished with non-zero exit code: {exit_code}"
+                )
+
+        except Exception as e:
+            raise _LabtaskerJobFailed(f"Error running command: {str(e)}")
+
+        logger.info(f"Task {task_info().task_id} ended.")
+
+    run_cmd()
+
+    logger.info("Loop ended.")

{labtasker-0.2.4 → labtasker-0.2.6}/labtasker/client/core/cli_utils.py

@@ -635,7 +635,11 @@ def make_a_choice(
         default=default,
         keyboard_interrupt_default=keyboard_interrupt_default,
     )
-    return asyncio.run(prompt.prompt_async())
+
+    try:
+        return asyncio.run(prompt.prompt_async())
+    except Exception:  # EOFError:  # e.g. closed connection under special circumstances
+        return default
 
 
 ls_format_iter = {

{labtasker-0.2.4 → labtasker-0.2.6}/labtasker/client/core/cmd_parser/generated/LabCmd.py

@@ -1,9 +1,8 @@
 # Generated from labtasker/client/core/cmd_parser/generated/LabCmd.g4 by ANTLR 4.13.2
 # encoding: utf-8
-import sys
+from labtasker.vendor.antlr4 import *
 from io import StringIO
-
-from antlr4 import *
+import sys
 
 if sys.version_info[1] > 5:
     from typing import TextIO

{labtasker-0.2.4 → labtasker-0.2.6}/labtasker/client/core/cmd_parser/generated/LabCmdLexer.py

@@ -1,8 +1,7 @@
 # Generated from labtasker/client/core/cmd_parser/generated/LabCmdLexer.g4 by ANTLR 4.13.2
-import sys
+from labtasker.vendor.antlr4 import *
 from io import StringIO
-
-from antlr4 import *
+import sys
 
 if sys.version_info[1] > 5:
     from typing import TextIO

{labtasker-0.2.4 → labtasker-0.2.6}/labtasker/client/core/cmd_parser/generated/LabCmdListener.py

@@ -1,5 +1,5 @@
 # Generated from labtasker/client/core/cmd_parser/generated/LabCmd.g4 by ANTLR 4.13.2
-from antlr4 import *
+from labtasker.vendor.antlr4 import *
 
 if "." in __name__:
     from .LabCmd import LabCmd

{labtasker-0.2.4 → labtasker-0.2.6}/labtasker/client/core/cmd_parser/parser.py

@@ -1,8 +1,6 @@
 import os
 from typing import Any, Dict, List, Set, Tuple, Union
 
-from antlr4 import CommonTokenStream, InputStream, ParserRuleContext, ParseTreeWalker
-from antlr4.error.ErrorListener import ErrorListener
 from rich import print
 from rich.console import Console
 from rich.text import Text
@@ -17,6 +15,13 @@ from labtasker.client.core.exceptions import (
     CmdTypeError,
 )
 from labtasker.client.core.logging import stderr_console
+from labtasker.vendor.antlr4 import (
+    CommonTokenStream,
+    InputStream,
+    ParserRuleContext,
+    ParseTreeWalker,
+)
+from labtasker.vendor.antlr4.error.ErrorListener import ErrorListener
 
 # Posix quote and windows quote
 if os.name == "nt":
@@ -158,10 +163,10 @@ def format_print_error(
 
 
 class CmdListener(LabCmdListener):
-    def __init__(self, variable_table, quote_dict: bool):
+    def __init__(self, variable_table, use_quote: bool):
         super().__init__()
         self.variable_table = variable_table
-        self.quote_dict = quote_dict
+        self.use_quote = use_quote
 
         self.result_str = ""
         self.args = set()
@@ -191,12 +196,15 @@ class CmdListener(LabCmdListener):
 
         if isinstance(self.variable, dict):
             # convert dict into bash string
-            if self.quote_dict:
+            # reverse quotes simplifies the conventional Python string representation
+            if self.use_quote:
                 self.result_str += quote(reverse_quotes(str(self.variable)))
             else:
                 self.result_str += reverse_quotes(str(self.variable))
         else:
-            self.result_str += str(self.variable)
+            self.result_str += (
+                quote(str(self.variable)) if self.use_quote else str(self.variable)
+            )
 
         self.variable = None
 
@@ -290,9 +298,7 @@ def cmd_interpolate(
         interpolated_cmd = []
         involved_keys = set()
         for c in cmd:
-            interpolated_str, keys = interpolate_str(
-                c, variable_table, quote_dict=False
-            )
+            interpolated_str, keys = interpolate_str(c, variable_table, use_quote=False)
             interpolated_cmd.append(interpolated_str)
             involved_keys.update(keys)
 
@@ -300,14 +306,14 @@ def cmd_interpolate(
 
 
 def interpolate_str(
-    input_str: str, variable_table: Dict[str, Any], quote_dict: bool = True
+    input_str: str, variable_table: Dict[str, Any], use_quote: bool = True
 ) -> Tuple[str, Set[str]]:
     """
 
     Args:
         input_str:
         variable_table:
-        quote_dict: quote dict string using shlex.quote
+        use_quote: quote dict or strings using shlex.quote
 
     Returns:
         interpolated str, involved keys
@@ -325,7 +331,7 @@ def interpolate_str(
     try:
         tree = parser.command()
         # Walk the parse tree with the custom listener
-        listener = CmdListener(variable_table=variable_table, quote_dict=quote_dict)
+        listener = CmdListener(variable_table=variable_table, use_quote=use_quote)
         walker = ParseTreeWalker()
         walker.walk(listener, tree)
     except CmdParserError as e:

{labtasker-0.2.4 → labtasker-0.2.6}/labtasker/client/core/job_runner.py

@@ -233,12 +233,15 @@ def loop_run(
                             #    B. Ignore: Reset task to back to PENDING with retries count set to 0, as if this crashed run never happened
 
                             # 1. log exception
-                            logger.error(f"Task {current_task_id()} failed")
-                            if not isinstance(e, _LabtaskerJobFailed):
-                                stderr_console.print_exception(
-                                    # hide traceback from internals
-                                    suppress=[labtasker]
-                                )
+                            if isinstance(e, KeyboardInterrupt):
+                                logger.warning("KeyboardInterrupt detected")
+                            else:
+                                logger.error(f"Task {current_task_id()} failed")
+                                if not isinstance(e, _LabtaskerJobFailed):
+                                    stderr_console.print_exception(
+                                        # hide traceback from internals
+                                        suppress=[labtasker]
+                                    )
 
                             # 2. ask the user
                             _next_action = "report"  # one of ["report", "ignore"]
@@ -256,7 +259,7 @@ def loop_run(
                                     ),
                                 ]
                                 choice = make_a_choice(
-                                    question="Task failed with the above exception. You have 10 seconds to make a choice:",
+                                    question="Task interrupted or failed with the above info. You have 10 seconds to make a choice:",
                                     options=choices,
                                     # if timed out while waiting for user input, we assume the user is not present and report this crash by default
                                     default=choices[0],