pyallel 0.2.1__tar.gz → 0.3.0__tar.gz

{pyallel-0.2.1 → pyallel-0.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: pyallel
-Version: 0.2.1
+Version: 0.3.0
 Summary: Run and handle the output of multiple executables in pyallel (as in parallel)
 Home-page: https://github.com/Danthewaann/pyallel
 License: MIT
@@ -50,8 +50,10 @@ pyallel "black --color --check --diff ." "mypy ." "ruff check --no-fix ."
       command
 - [ ] Add custom config file for `pyallel` to read from as an alternative to providing
       arguments via the command line
-- [ ] Add support for providing config via a `pyproject.toml` file in the current
-      working directory
+- [ ] Add support for providing config via a `[tool.pyallel]` section in a
+      `pyproject.toml` file in the current working directory
+- [ ] Maybe allow command dependencies to be defined in a python file where commands are
+      decorated with info that details it's dependencies?
 - [ ] Add test suite
 - [ ] Improve error handling when parsing provided commands (check they are valid executables)
 - [ ] Add visual examples of `pyallel` in action

{pyallel-0.2.1 → pyallel-0.3.0}/README.md

@@ -32,8 +32,10 @@ pyallel "black --color --check --diff ." "mypy ." "ruff check --no-fix ."
       command
 - [ ] Add custom config file for `pyallel` to read from as an alternative to providing
       arguments via the command line
-- [ ] Add support for providing config via a `pyproject.toml` file in the current
-      working directory
+- [ ] Add support for providing config via a `[tool.pyallel]` section in a
+      `pyproject.toml` file in the current working directory
+- [ ] Maybe allow command dependencies to be defined in a python file where commands are
+      decorated with info that details it's dependencies?
 - [ ] Add test suite
 - [ ] Improve error handling when parsing provided commands (check they are valid executables)
 - [ ] Add visual examples of `pyallel` in action

{pyallel-0.2.1 → pyallel-0.3.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "pyallel"
-version = "0.2.1"
+version = "0.3.0"
 description = "Run and handle the output of multiple executables in pyallel (as in parallel)"
 authors = ["Daniel Black <danielcrblack@gmail.com>"]
 license = "MIT"
@@ -16,15 +16,22 @@ classifiers = [
 ]
 
 [tool.poetry.scripts]
-pyallel = "pyallel.main:run"
+pyallel = "pyallel.main:entry_point"
 
 [tool.poetry.dependencies]
 python = ">=3.11,<4.0"
 
+[tool.poetry.group.dev.dependencies]
+pytest = "^7.4.3"
+mypy = "^1.7.0"
+
 [tool.mypy]
 strict = true
 show_error_codes = true
 
+[tool.pytest.ini_options]
+addopts = "-vvv"
+
 [build-system]
 requires = ["poetry-core"]
 build-backend = "poetry.core.masonry.api"

{pyallel-0.2.1 → pyallel-0.3.0}/src/pyallel/main.py

@@ -1,42 +1,41 @@
-import argparse
 import os
 import sys
 import time
-from datetime import timedelta
 from dataclasses import dataclass
+import shlex
 import importlib.metadata
 import subprocess
 
-WHITE_BOLD = "\033[1m"
-GREEN_BOLD = "\033[1;32m"
-BLUE_BOLD = "\033[1;34m"
-RED_BOLD = "\033[1;31m"
-NC = "\033[0m"
-CLEAR_LINE = "\033[2K"
-UP_LINE = "\033[1F"
-ICONS = ("/", "-", "\\", "|")
+from pyallel.parser import Arguments, create_parser
+
+IN_TTY = sys.__stdin__.isatty()
+
+if IN_TTY:
+    WHITE_BOLD = "\033[1m"
+    GREEN_BOLD = "\033[1;32m"
+    BLUE_BOLD = "\033[1;34m"
+    RED_BOLD = "\033[1;31m"
+    CLEAR_LINE = "\033[2K"
+    UP_LINE = "\033[1F"
+    NC = "\033[0m"
+    CR = "\r"
+else:
+    WHITE_BOLD = ""
+    GREEN_BOLD = ""
+    BLUE_BOLD = ""
+    RED_BOLD = ""
+    CLEAR_LINE = ""
+    UP_LINE = ""
+    NC = ""
+    CR = ""
+
 
+ICONS = ("/", "-", "\\", "|")
 # Unicode character bytes to render different symbols in the terminal
 TICK = "\u2713"
 X = "\u2717"
 
 
-class Arguments:
-    commands: list[str]
-    fail_fast: bool
-    interactive: bool
-    debug: bool
-    verbose: bool
-    version: bool
-
-    def __repr__(self) -> str:
-        msg = "Arguments:\n"
-        padding = len(sorted(self.__dict__.keys(), key=len, reverse=True)[0]) + 1
-        for field, value in self.__dict__.items():
-            msg += f"    {field: <{padding}}: {value}\n"
-        return msg
-
-
 @dataclass
 class Process:
     name: str
@@ -46,7 +45,8 @@ class Process:
 
 
 def run_command(command: str) -> Process:
-    executable, *args = command.split()
+    executable, *args = command.split(maxsplit=1)
+    args = shlex.split(" ".join(args))
     env = os.environ.copy()
     start = time.perf_counter()
     process = subprocess.Popen(
@@ -60,52 +60,6 @@ def run_command(command: str) -> Process:
     return Process(name=executable, args=args, start=start, process=process)
 
 
-def create_parser() -> argparse.ArgumentParser:
-    parser = argparse.ArgumentParser(
-        prog="pyallel",
-        description="Run and handle the output of multiple executables in pyallel (as in parallel)",
-    )
-    parser.add_argument("commands", help="list of commands to run", nargs="*")
-    parser.add_argument(
-        "-f",
-        "--fail-fast",
-        help="exit immediately when a command fails",
-        action="store_true",
-        default=False,
-    )
-    parser.add_argument(
-        "-n",
-        "--non-interactive",
-        help="run in non-interactive mode",
-        action="store_false",
-        dest="interactive",
-        default=True,
-    )
-    parser.add_argument(
-        "-d",
-        "--debug",
-        help="output debug info for each command",
-        action="store_true",
-        default=False,
-    )
-    parser.add_argument(
-        "-V",
-        "--verbose",
-        help="run in verbose mode",
-        action="store_true",
-        default=False,
-    )
-    parser.add_argument(
-        "-v",
-        "--version",
-        help="print version and exit",
-        action="store_true",
-        default=False,
-    )
-
-    return parser
-
-
 def run_commands(commands: list[str]) -> list[Process]:
     return [run_command(command) for command in commands]
 
@@ -127,13 +81,13 @@ def format_time_taken(time_taken: float) -> str:
     elif 60 <= time_taken < 3600:
         msg = f"{minutes}m"
         if seconds:
-            msg += f" {seconds}s" 
+            msg += f" {seconds}s"
     elif time_taken >= 3600:
         msg = f"{hour}h"
         if minutes:
-            msg += f" {minutes}m" 
+            msg += f" {minutes}m"
         if seconds:
-            msg += f" {seconds}s" 
+            msg += f" {seconds}s"
 
     return msg
 
@@ -179,20 +133,22 @@ def main_loop(
     completed_processes: set[str] = set()
     passed = True
 
-    if not interactive:
+    if not interactive or not IN_TTY:
         print(f"{WHITE_BOLD}Running commands...{NC}\n")
 
     while True:
-        if interactive:
+        if interactive and IN_TTY:
             for icon in ICONS:
-                print(f"{CLEAR_LINE}\r{WHITE_BOLD}Running commands{NC} {icon}", end="")
+                print(
+                    f"{CLEAR_LINE}{CR}{WHITE_BOLD}Running commands{NC} {icon}", end=""
+                )
                 time.sleep(0.1)
 
         for process in processes:
             if process.name in completed_processes or process.process.poll() is None:
                 continue
 
-            print(f"${CLEAR_LINE}\r", end="")
+            print(f"{CLEAR_LINE}{CR}", end="")
             completed_processes.add(process.name)
 
             if process.process.returncode != 0:
@@ -212,35 +168,43 @@ def main_loop(
     return passed
 
 
-def run() -> None:
+def run(*args: str) -> int:
     parser = create_parser()
-    args = parser.parse_args(namespace=Arguments())
-    if args.version:
+    parsed_args = parser.parse_args(args=args, namespace=Arguments())
+
+    if parsed_args.version:
         my_version = importlib.metadata.version("pyallel")
         print(my_version)
-        sys.exit(0)
-
-    if not sys.stdin.isatty():
-        print(sys.stdin.read())
+        return 0
 
-    if args.verbose:
-        print(args)
+    if parsed_args.verbose:
+        print(parsed_args)
 
-    if not args.commands:
+    if not parsed_args.commands:
         parser.print_help()
-        sys.exit(2)
+        return 2
 
-    start_time = time.perf_counter()
+    start = time.perf_counter()
 
     exit_code = 0
-    status = main_loop(args.commands, args.fail_fast, args.interactive, args.debug)
+    status = main_loop(
+        parsed_args.commands,
+        parsed_args.fail_fast,
+        parsed_args.interactive,
+        parsed_args.debug,
+    )
     if not status:
         print(f"{RED_BOLD}A command failed!{NC}")
         exit_code = 1
     else:
         print(f"{GREEN_BOLD}Success!{NC}")
 
-    elapsed_time = time.perf_counter() - start_time
-    if args.debug:
-        print(f"\nTime taken : {format_time_taken(elapsed_time)}")
-    sys.exit(exit_code)
+    if parsed_args.debug:
+        elapsed = time.perf_counter() - start
+        print(f"\nTime taken : {format_time_taken(elapsed)}")
+
+    return exit_code
+
+
+def entry_point() -> None:
+    sys.exit(run(*sys.argv[1:]))

pyallel-0.3.0/src/pyallel/parser.py

@@ -0,0 +1,63 @@
+from argparse import ArgumentParser
+
+
+class Arguments:
+    commands: list[str]
+    fail_fast: bool
+    interactive: bool
+    debug: bool
+    verbose: bool
+    version: bool
+
+    def __repr__(self) -> str:
+        msg = "Arguments:\n"
+        padding = len(sorted(self.__dict__.keys(), key=len, reverse=True)[0]) + 1
+        for field, value in self.__dict__.items():
+            msg += f"    {field: <{padding}}: {value}\n"
+        return msg
+
+
+def create_parser() -> ArgumentParser:
+    parser = ArgumentParser(
+        prog="pyallel",
+        description="Run and handle the output of multiple executables in pyallel (as in parallel)",
+    )
+    parser.add_argument("commands", help="list of commands to run", nargs="*")
+    parser.add_argument(
+        "-f",
+        "--fail-fast",
+        help="exit immediately when a command fails",
+        action="store_true",
+        default=False,
+    )
+    parser.add_argument(
+        "-n",
+        "--non-interactive",
+        help="run in non-interactive mode",
+        action="store_false",
+        dest="interactive",
+        default=True,
+    )
+    parser.add_argument(
+        "-d",
+        "--debug",
+        help="output debug info for each command",
+        action="store_true",
+        default=False,
+    )
+    parser.add_argument(
+        "-V",
+        "--verbose",
+        help="run in verbose mode",
+        action="store_true",
+        default=False,
+    )
+    parser.add_argument(
+        "-v",
+        "--version",
+        help="print version and exit",
+        action="store_true",
+        default=False,
+    )
+
+    return parser