pyallel 1.3.7__tar.gz → 2.0.0__tar.gz

{pyallel-1.3.7 → pyallel-2.0.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: pyallel
-Version: 1.3.7
+Version: 2.0.0
 Summary: Run and handle the output of multiple executables in pyallel (as in parallel)
 Home-page: https://github.com/Danthewaann/pyallel
 License: MIT
@@ -47,42 +47,54 @@ Once installed, you can run `pyallel` to see usage information, like so:
 ```
 usage: pyallel [-h] [-t] [-n] [-V] [--colour {yes,no,auto}] [commands ...]
 
-Run and handle the output of multiple executables in pyallel (as in parallel)
+run and handle the output of multiple executables in pyallel (as in parallel)
 
-positional arguments:
-  commands              list of quoted commands to run in parallel e.g "mypy ." "black ."
+RUNNING COMMANDS
+================
+to run multiple commands you must separate them using the command separator symbol (::)
+
+  pyallel mypy . :: black .
+
+if you want to provide options to a command you need to use the double dash symbol (--) to indicate that
+any options provided after this symbol should not be interpreted by pyallel
+
+  pyallel -n -- mypy -V :: black --version
 
-                        each command is executed inside a shell, so shell syntax is supported as
-                        if you were running the command directly in a shell, some examples are below
+commands can also be grouped using the group separator symbol (:::)
 
-                             "MYPY_FORCE_COLOR=1 mypy ."          <- provide environment variables
-                             "mypy | tee -a mypy.log"             <- use pipes to redirect output
-                             "cat > test.log < other.log"         <- use input and output redirection
-                             "mypy .; pytest ."                   <- run commands one at a time in sequence
-                             "echo \$SHELL" or "\$(echo mypy .)"  <- expand variables and commands to evaluate (must be escaped)
-                             "pytest . && mypy . || echo failed!" <- use AND (&&) and OR (||) to run commands conditionally
+  pyallel echo boil kettle :: sleep 1 ::: echo make coffee
 
-                        PROCESS GROUPS
-                        --------------
-                        commands can be grouped using the group separator symbol (:::)
+the above will print 'boil kettle' and sleep for 1 second first before printing 'make coffee'.
+command groups are ran in the sequence you provide them, and if a command within a command group fails,
+the rest of the command groups in the sequence are not run
 
-                             pyallel "echo boil kettle" "sleep 1" ::: "echo make coffee"
+modifiers can also be set for commands to augment their behaviour using the command modifier symbol (::::)
 
-                        the above will print "boil kettle" and sleep for 1 second first before printing "make coffee"
+lines (only used in interactive mode):
+  the lines modifier allows you to specify how many lines the command output can take up on the screen
 
-                        command groups are ran in the sequence you provide them, and if a command group fails
-                        (if a command fails inside the command group) the rest of the command groups in the sequence are not run
+    pyallel lines=90 :::: echo running long command... :: echo running other command...
 
-                        COMMAND MODIFIERS
-                        -----------------
-                        modifiers can be set for commands to augment their behaviour using the command modifier symbol (::)
+  90 is expressed as a percentage value, which must be between 1 and 100 inclusive
 
-                        lines (only used in interactive mode):
-                            the lines modifier allows you to specify how many lines the command output can take up on the screen
+SHELL SYNTAX
+============
+each command is executed inside its own shell, this means shell syntax is supported.
+it is important to note that certain shell syntax must be escaped using backslashes (\)
+or wrapped in single quotes (''), otherwise it will be evaluated in your current
+shell immediately instead of the shell that your command will run within.
 
-                                pyallel "lines=90 :: echo running long command..." "echo running other command..."
+some examples of using shell syntax are below (single quotes are used only if required)
 
-                            90 is expressed as a percentage value, which must be between 1 and 100 inclusive
+  pyallel MYPY_FORCE_COLOR=1 mypy .            <- provide environment variables
+  pyallel 'mypy . | tee -a mypy.log'           <- use pipes to redirect output
+  pyallel 'cat > test.log <<< hello!'          <- use input and output redirection
+  pyallel 'mypy .; pytest .'                   <- run commands one at a time in sequence
+  pyallel 'echo $SHELL; $(echo mypy .)'        <- expand variables and commands to evaluate
+  pyallel 'pytest . && mypy . || echo failed!' <- use AND (&&) and OR (||) to run commands conditionally
+
+positional arguments:
+  commands              list of commands and their arguments to run in parallel
 
 options:
   -h, --help            show this help message and exit
@@ -96,13 +108,8 @@ options:
 
 Currently you can provide a variable number of `commands` to run to `pyallel`, like so:
 
-> [!IMPORTANT]
-> If you need to provide arguments to a command, you must surround the command and it's arguments in quotes!
-
 ```bash
-pyallel "MYPY_FORCE_COLOR=1 mypy ." \
-        "black --check --diff ." \
-        "pytest ."
+pyallel MYPY_FORCE_COLOR=1 mypy . :: black --check --diff . :: pytest .
 ```
 
 # Build

{pyallel-1.3.7 → pyallel-2.0.0}/README.md

@@ -23,42 +23,54 @@ Once installed, you can run `pyallel` to see usage information, like so:
 ```
 usage: pyallel [-h] [-t] [-n] [-V] [--colour {yes,no,auto}] [commands ...]
 
-Run and handle the output of multiple executables in pyallel (as in parallel)
+run and handle the output of multiple executables in pyallel (as in parallel)
 
-positional arguments:
-  commands              list of quoted commands to run in parallel e.g "mypy ." "black ."
+RUNNING COMMANDS
+================
+to run multiple commands you must separate them using the command separator symbol (::)
+
+  pyallel mypy . :: black .
+
+if you want to provide options to a command you need to use the double dash symbol (--) to indicate that
+any options provided after this symbol should not be interpreted by pyallel
+
+  pyallel -n -- mypy -V :: black --version
 
-                        each command is executed inside a shell, so shell syntax is supported as
-                        if you were running the command directly in a shell, some examples are below
+commands can also be grouped using the group separator symbol (:::)
 
-                             "MYPY_FORCE_COLOR=1 mypy ."          <- provide environment variables
-                             "mypy | tee -a mypy.log"             <- use pipes to redirect output
-                             "cat > test.log < other.log"         <- use input and output redirection
-                             "mypy .; pytest ."                   <- run commands one at a time in sequence
-                             "echo \$SHELL" or "\$(echo mypy .)"  <- expand variables and commands to evaluate (must be escaped)
-                             "pytest . && mypy . || echo failed!" <- use AND (&&) and OR (||) to run commands conditionally
+  pyallel echo boil kettle :: sleep 1 ::: echo make coffee
 
-                        PROCESS GROUPS
-                        --------------
-                        commands can be grouped using the group separator symbol (:::)
+the above will print 'boil kettle' and sleep for 1 second first before printing 'make coffee'.
+command groups are ran in the sequence you provide them, and if a command within a command group fails,
+the rest of the command groups in the sequence are not run
 
-                             pyallel "echo boil kettle" "sleep 1" ::: "echo make coffee"
+modifiers can also be set for commands to augment their behaviour using the command modifier symbol (::::)
 
-                        the above will print "boil kettle" and sleep for 1 second first before printing "make coffee"
+lines (only used in interactive mode):
+  the lines modifier allows you to specify how many lines the command output can take up on the screen
 
-                        command groups are ran in the sequence you provide them, and if a command group fails
-                        (if a command fails inside the command group) the rest of the command groups in the sequence are not run
+    pyallel lines=90 :::: echo running long command... :: echo running other command...
 
-                        COMMAND MODIFIERS
-                        -----------------
-                        modifiers can be set for commands to augment their behaviour using the command modifier symbol (::)
+  90 is expressed as a percentage value, which must be between 1 and 100 inclusive
 
-                        lines (only used in interactive mode):
-                            the lines modifier allows you to specify how many lines the command output can take up on the screen
+SHELL SYNTAX
+============
+each command is executed inside its own shell, this means shell syntax is supported.
+it is important to note that certain shell syntax must be escaped using backslashes (\)
+or wrapped in single quotes (''), otherwise it will be evaluated in your current
+shell immediately instead of the shell that your command will run within.
 
-                                pyallel "lines=90 :: echo running long command..." "echo running other command..."
+some examples of using shell syntax are below (single quotes are used only if required)
 
-                            90 is expressed as a percentage value, which must be between 1 and 100 inclusive
+  pyallel MYPY_FORCE_COLOR=1 mypy .            <- provide environment variables
+  pyallel 'mypy . | tee -a mypy.log'           <- use pipes to redirect output
+  pyallel 'cat > test.log <<< hello!'          <- use input and output redirection
+  pyallel 'mypy .; pytest .'                   <- run commands one at a time in sequence
+  pyallel 'echo $SHELL; $(echo mypy .)'        <- expand variables and commands to evaluate
+  pyallel 'pytest . && mypy . || echo failed!' <- use AND (&&) and OR (||) to run commands conditionally
+
+positional arguments:
+  commands              list of commands and their arguments to run in parallel
 
 options:
   -h, --help            show this help message and exit
@@ -72,13 +84,8 @@ options:
 
 Currently you can provide a variable number of `commands` to run to `pyallel`, like so:
 
-> [!IMPORTANT]
-> If you need to provide arguments to a command, you must surround the command and it's arguments in quotes!
-
 ```bash
-pyallel "MYPY_FORCE_COLOR=1 mypy ." \
-        "black --check --diff ." \
-        "pytest ."
+pyallel MYPY_FORCE_COLOR=1 mypy . :: black --check --diff . :: pytest .
 ```
 
 # Build

{pyallel-1.3.7 → pyallel-2.0.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "pyallel"
-version = "1.3.7"
+version = "2.0.0"
 description = "Run and handle the output of multiple executables in pyallel (as in parallel)"
 authors = ["Daniel Black <danielcrblack@gmail.com>"]
 license = "MIT"

pyallel-2.0.0/src/pyallel/errors.py

@@ -0,0 +1,10 @@
+class PyallelError(Exception):
+    """Base error for issues raised by pyallel"""
+
+
+class InvalidLinesModifierError(PyallelError):
+    """Raised when the lines modifier is invalid"""
+
+
+class NoCommandsForProcessGroupError(PyallelError):
+    """Raised when no commands have been provided for a process group"""

{pyallel-1.3.7 → pyallel-2.0.0}/src/pyallel/main.py

@@ -7,7 +7,7 @@ import traceback
 
 from pyallel import constants
 from pyallel.colours import Colours
-from pyallel.errors import InvalidLinesModifierError
+from pyallel.errors import PyallelError
 from pyallel.parser import Arguments, create_parser
 from pyallel.printer import (
     InteractiveConsolePrinter,
@@ -40,7 +40,7 @@ def entry_point(*args: str) -> int:
 
     try:
         process_group_manager = ProcessGroupManager.from_args(*parsed_args.commands)
-    except InvalidLinesModifierError as e:
+    except PyallelError as e:
         print(f"{colours.red_bold}Error: {str(e)}{colours.reset_colour}")
         return 1
 

pyallel-2.0.0/src/pyallel/parser.py

@@ -0,0 +1,112 @@
+from __future__ import annotations
+
+from argparse import ArgumentParser, RawTextHelpFormatter
+from typing import Literal
+
+
+class Arguments:
+    colour: Literal["yes", "no", "auto"]
+    commands: list[str]
+    interactive: bool
+    timer: 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
+
+
+DESCRIPTION = r"""run and handle the output of multiple executables in %(prog)s (as in parallel)
+
+RUNNING COMMANDS
+================
+to run multiple commands you must separate them using the command separator symbol (::)
+    
+  %(prog)s mypy . :: black .
+
+if you want to provide options to a command you need to use the double dash symbol (--) to indicate that 
+any options provided after this symbol should not be interpreted by %(prog)s 
+
+  %(prog)s -n -- mypy -V :: black --version
+
+commands can also be grouped using the group separator symbol (:::)
+
+  %(prog)s echo boil kettle :: sleep 1 ::: echo make coffee
+
+the above will print 'boil kettle' and sleep for 1 second first before printing 'make coffee'.
+command groups are ran in the sequence you provide them, and if a command within a command group fails,
+the rest of the command groups in the sequence are not run
+
+
+modifiers can also be set for commands to augment their behaviour using the command modifier symbol (::::)
+
+lines (only used in interactive mode):
+  the lines modifier allows you to specify how many lines the command output can take up on the screen
+        
+    %(prog)s lines=90 :::: echo running long command... :: echo running other command...
+
+  90 is expressed as a percentage value, which must be between 1 and 100 inclusive
+
+SHELL SYNTAX
+============
+each command is executed inside its own shell, this means shell syntax is supported.
+it is important to note that certain shell syntax must be escaped using backslashes (\)
+or wrapped in single quotes (''), otherwise it will be evaluated in your current 
+shell immediately instead of the shell that your command will run within.
+
+some examples of using shell syntax are below (single quotes are used only if required)
+
+  %(prog)s MYPY_FORCE_COLOR=1 mypy .            <- provide environment variables
+  %(prog)s 'mypy . | tee -a mypy.log'           <- use pipes to redirect output
+  %(prog)s 'cat > test.log <<< hello!'          <- use input and output redirection
+  %(prog)s 'mypy .; pytest .'                   <- run commands one at a time in sequence
+  %(prog)s 'echo $SHELL; $(echo mypy .)'        <- expand variables and commands to evaluate
+  %(prog)s 'pytest . && mypy . || echo failed!' <- use AND (&&) and OR (||) to run commands conditionally
+"""
+
+
+def create_parser() -> ArgumentParser:
+    parser = ArgumentParser(
+        prog="pyallel",
+        description=DESCRIPTION,
+        formatter_class=RawTextHelpFormatter,
+    )
+    parser.add_argument(
+        "commands",
+        help="list of commands and their arguments to run in parallel",
+        nargs="*",
+    )
+    parser.add_argument(
+        "-t",
+        "--no-timer",
+        dest="timer",
+        help="don't time how long each command is taking",
+        action="store_false",
+        default=True,
+    )
+    parser.add_argument(
+        "-n",
+        "--non-interactive",
+        help="run in non-interactive mode",
+        action="store_false",
+        dest="interactive",
+        default=True,
+    )
+    parser.add_argument(
+        "-V",
+        "--version",
+        help="print version and exit",
+        action="store_true",
+        default=False,
+    )
+    parser.add_argument(
+        "--colour",
+        help='colour terminal output, defaults to "%(default)s"',
+        choices=("yes", "no", "auto"),
+        default="auto",
+    )
+
+    return parser

{pyallel-1.3.7 → pyallel-2.0.0}/src/pyallel/process.py

@@ -78,7 +78,7 @@ class Process:
 
     @classmethod
     def from_command(cls, id: int, command: str) -> Process:
-        cmd = command.split(" :: ", maxsplit=1)
+        cmd = command.split(" :::: ", maxsplit=1)
         if len(cmd) == 1:
             return cls(id, cmd[0])
 

{pyallel-1.3.7 → pyallel-2.0.0}/src/pyallel/process_group.py

@@ -64,11 +64,22 @@ class ProcessGroup:
 
     @classmethod
     def from_commands(cls, id: int, process_id: int, *commands: str) -> ProcessGroup:
+        cmds: list[str] = []
         processes: list[Process] = []
 
         percentage_lines_sum = 0.0
         for i, command in enumerate(commands):
-            process = Process.from_command(i + process_id, command)
+            if command != "::":
+                cmds.append(command)
+                continue
+
+            process = Process.from_command(i + process_id, " ".join(cmds))
+            percentage_lines_sum += process.percentage_lines
+            processes.append(process)
+            cmds.clear()
+
+        if cmds:
+            process = Process.from_command(i + process_id, " ".join(cmds))
             percentage_lines_sum += process.percentage_lines
             processes.append(process)
 

{pyallel-1.3.7 → pyallel-2.0.0}/src/pyallel/process_group_manager.py

@@ -3,6 +3,7 @@ from __future__ import annotations
 import signal
 from typing import Any
 
+from pyallel.errors import NoCommandsForProcessGroupError
 from pyallel.process import ProcessOutput
 from pyallel.process_group import ProcessGroupOutput, ProcessGroup
 
@@ -113,39 +114,31 @@ class ProcessGroupManager:
 
     @classmethod
     def from_args(cls, *args: str) -> ProcessGroupManager:
-        last_separator_index = 0
         commands: list[str] = []
         process_groups: list[ProcessGroup] = []
         progress_group_id = 1
         process_id = 1
 
-        for i, arg in enumerate(args):
-            if arg == ":::":
-                if i - 1 == 0:
-                    pg = ProcessGroup.from_commands(
-                        progress_group_id, process_id, args[0]
-                    )
-                else:
-                    pg = ProcessGroup.from_commands(
-                        progress_group_id, process_id, *commands[last_separator_index:]
-                    )
-
-                process_groups.append(pg)
-                process_id += len(pg.processes)
-                last_separator_index = i
-                progress_group_id += 1
+        for arg in args:
+            if arg != ":::":
+                commands.append(arg)
                 continue
 
-            commands.append(arg)
+            if not commands:
+                raise NoCommandsForProcessGroupError(
+                    f"no commands provided for process group {progress_group_id}, did you forgot to provide them before the ::: symbol?"
+                )
 
-        if len(process_groups) > 1:
-            last_separator_index -= 1
+            pg = ProcessGroup.from_commands(progress_group_id, process_id, *commands)
+            process_groups.append(pg)
+            process_id += len(pg.processes)
+            progress_group_id += 1
+            commands.clear()
 
-        process_groups.append(
-            ProcessGroup.from_commands(
-                progress_group_id, process_id, *commands[last_separator_index:]
+        if commands:
+            process_groups.append(
+                ProcessGroup.from_commands(progress_group_id, process_id, *commands)
             )
-        )
 
         process_group_manager = cls(process_groups=process_groups)
 

pyallel-1.3.7/src/pyallel/errors.py

@@ -1,2 +0,0 @@
-class InvalidLinesModifierError(Exception):
-    """Raised when the lines modifier is invalid"""

pyallel-1.3.7/src/pyallel/parser.py

@@ -1,99 +0,0 @@
-from __future__ import annotations
-
-from argparse import ArgumentParser, RawTextHelpFormatter
-from typing import Literal
-
-
-class Arguments:
-    colour: Literal["yes", "no", "auto"]
-    commands: list[str]
-    interactive: bool
-    timer: 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
-
-
-COMMANDS_HELP = r"""list of quoted commands to run in parallel e.g "mypy ." "black ."
-
-each command is executed inside a shell, so shell syntax is supported as
-if you were running the command directly in a shell, some examples are below
-
-     "MYPY_FORCE_COLOR=1 mypy ."          <- provide environment variables
-     "mypy | tee -a mypy.log"             <- use pipes to redirect output
-     "cat > test.log < other.log"         <- use input and output redirection
-     "mypy .; pytest ."                   <- run commands one at a time in sequence
-     "echo \$SHELL" or "\$(echo mypy .)"  <- expand variables and commands to evaluate (must be escaped)
-     "pytest . && mypy . || echo failed!" <- use AND (&&) and OR (||) to run commands conditionally
-
-PROCESS GROUPS
---------------
-commands can be grouped using the group separator symbol (:::)
-
-     %(prog)s "echo boil kettle" "sleep 1" ::: "echo make coffee"
-
-the above will print "boil kettle" and sleep for 1 second first before printing "make coffee"
-
-command groups are ran in the sequence you provide them, and if a command group fails
-(if a command fails inside the command group) the rest of the command groups in the sequence are not run
-
-COMMAND MODIFIERS
------------------
-modifiers can be set for commands to augment their behaviour using the command modifier symbol (::)
-
-lines (only used in interactive mode):
-    the lines modifier allows you to specify how many lines the command output can take up on the screen
-        
-        %(prog)s "lines=90 :: echo running long command..." "echo running other command..."
-
-    90 is expressed as a percentage value, which must be between 1 and 100 inclusive
-"""
-
-
-def create_parser() -> ArgumentParser:
-    parser = ArgumentParser(
-        prog="pyallel",
-        description="Run and handle the output of multiple executables in pyallel (as in parallel)",
-        formatter_class=RawTextHelpFormatter,
-    )
-    parser.add_argument(
-        "commands",
-        help=COMMANDS_HELP,
-        nargs="*",
-    )
-    parser.add_argument(
-        "-t",
-        "--no-timer",
-        dest="timer",
-        help="don't time how long each command is taking",
-        action="store_false",
-        default=True,
-    )
-    parser.add_argument(
-        "-n",
-        "--non-interactive",
-        help="run in non-interactive mode",
-        action="store_false",
-        dest="interactive",
-        default=True,
-    )
-    parser.add_argument(
-        "-V",
-        "--version",
-        help="print version and exit",
-        action="store_true",
-        default=False,
-    )
-    parser.add_argument(
-        "--colour",
-        help='colour terminal output, defaults to "%(default)s"',
-        choices=("yes", "no", "auto"),
-        default="auto",
-    )
-
-    return parser