cmd-queue 0.2.0__py3-none-any.whl → 0.2.2__py3-none-any.whl

cmd_queue/__init__.py

@@ -306,7 +306,7 @@ Example:
 __mkinit__ = """
 mkinit -m cmd_queue
 """
-__version__ = '0.2.0'
+__version__ = '0.2.2'
 
 
 __submodules__ = {

cmd_queue/serial_queue.py

@@ -7,30 +7,7 @@ import ubelt as ub
 import uuid
 from cmd_queue import base_queue
 from cmd_queue.util import util_tags
-
-
-def indent(text, prefix='    '):
-    r"""
-    Indents a block of text
-
-    Args:
-        text (str): text to indent
-        prefix (str, default = '    '): prefix to add to each line
-
-    Returns:
-        str: indented text
-
-        >>> from cmd_queue.serial_queue import *  # NOQA
-        >>> text = ['aaaa', 'bb', 'cc\n   dddd\n    ef\n']
-        >>> text = indent(text)
-        >>> print(text)
-        >>> text = indent(text)
-        >>> print(text)
-    """
-    if isinstance(text, (list, tuple)):
-        return indent('\n'.join(text), prefix)
-    else:
-        return prefix + text.replace('\n', '\n' + prefix)
+from cmd_queue.util import util_bash
 
 
 class BashJob(base_queue.Job):
@@ -115,6 +92,21 @@ class BashJob(base_queue.Job):
         self.tags = util_tags.Tags.coerce(tags)
         self.allow_indent = allow_indent
 
+    def _test_bash_syntax_errors(self):
+        """
+        Check for bash syntax errors
+
+        Example:
+            >>> from cmd_queue.serial_queue import *  # NOQA
+            >>> # Demo full boilerplate for a job with dependencies
+            >>> self = BashJob('basd syhi(', name='job1')
+            >>> import pytest
+            >>> with pytest.raises(SyntaxError):
+            >>>     self._test_bash_syntax_errors()
+        """
+        bash_text = self.finalize_text()
+        _check_bash_text_for_syntax_errors(bash_text)
+
     def finalize_text(self, with_status=True, with_gaurds=True,
                       conditionals=None, **kwargs):
         script = []
@@ -178,7 +170,8 @@ class BashJob(base_queue.Job):
                 json_fmt_parts += [
                     ('logs', '"%s"', self.log_fpath),
                 ]
-            dump_pre_status = _bash_json_dump(json_fmt_parts, self.stat_fpath)
+            dump_pre_status = util_bash.bash_json_dump(json_fmt_parts,
+                                                       self.stat_fpath)
             script.append('# Mark job as running')
             script.append(dump_pre_status)
 
@@ -247,7 +240,8 @@ class BashJob(base_queue.Job):
                 json_fmt_parts += [
                     ('logs', '"%s"', self.log_fpath),
                 ]
-            dump_post_status = _bash_json_dump(json_fmt_parts, self.stat_fpath)
+            dump_post_status = util_bash.bash_json_dump(json_fmt_parts,
+                                                        self.stat_fpath)
 
             on_pass_part = indent(_job_conditionals['on_pass'])
             on_fail_part = indent(_job_conditionals['on_fail'])
@@ -468,7 +462,8 @@ class SerialQueue(base_queue.Queue):
                     ('name', '"%s"', self.name),
                     ('rootid', '"%s"', self.rootid),
                 ]
-                dump_code = _bash_json_dump(json_fmt_parts, self.state_fpath)
+                dump_code = util_bash.bash_json_dump(json_fmt_parts,
+                                                     self.state_fpath)
                 script.append('# Update queue status')
                 script.append(dump_code)
                 # script.append('cat ' + str(self.state_fpath))
@@ -575,6 +570,10 @@ class SerialQueue(base_queue.Queue):
         r"""
         Print info about the commands, optionally with rich
 
+        Args:
+            *args: see :func:`cmd_queue.base_queue.Queue.print_commands`.
+            **kwargs: see :func:`cmd_queue.base_queue.Queue.print_commands`.
+
         CommandLine:
             xdoctest -m cmd_queue.serial_queue SerialQueue.print_commands
 
@@ -675,41 +674,38 @@ class SerialQueue(base_queue.Queue):
         return state
 
 
-def _bash_json_dump(json_fmt_parts, fpath):
-    """
-    Make a printf command that dumps a json file indicating some status in a
-    bash environment.
+def indent(text, prefix='    '):
+    r"""
+    Indents a block of text
 
     Args:
-        List[Tuple[str, str, str]]: A list of 3-tupels indicating the name of
-            the json key, the printf code, and the bash expression to fill the
-            printf code.
-
-        fpath (str): where bash should write the json file
+        text (str): text to indent
+        prefix (str, default = '    '): prefix to add to each line
 
     Returns:
-        str : the bash that will perform the printf
+        str: indented text
 
-    Example:
-        >>> from cmd_queue.serial_queue import _bash_json_dump
-        >>> json_fmt_parts = [
-        >>>     ('home', '%s', '$HOME'),
-        >>>     ('const', '%s', 'MY_CONSTANT'),
-        >>>     ('ps2', '"%s"', '$PS2'),
-        >>> ]
-        >>> fpath = 'out.json'
-        >>> dump_code = _bash_json_dump(json_fmt_parts, fpath)
-        >>> print(dump_code)
+        >>> from cmd_queue.serial_queue import *  # NOQA
+        >>> text = ['aaaa', 'bb', 'cc\n   dddd\n    ef\n']
+        >>> text = indent(text)
+        >>> print(text)
+        >>> text = indent(text)
+        >>> print(text)
     """
-    printf_body_parts = [
-        '"{}": {}'.format(k, f) for k, f, v in json_fmt_parts
-    ]
-    printf_arg_parts = [
-        '"{}"'.format(v) for k, f, v in json_fmt_parts
-    ]
-    printf_body = r"'{" + ", ".join(printf_body_parts) + r"}\n'"
-    printf_args = ' '.join(printf_arg_parts)
-    redirect_part = '> ' + str(fpath)
-    printf_part = 'printf ' +  printf_body + ' \\\n    ' + printf_args
-    dump_code = printf_part + ' \\\n    ' + redirect_part
-    return dump_code
+    if isinstance(text, (list, tuple)):
+        return indent('\n'.join(text), prefix)
+    else:
+        return prefix + text.replace('\n', '\n' + prefix)
+
+
+def _check_bash_text_for_syntax_errors(bash_text):
+    import tempfile
+    tmpdir = tempfile.TemporaryDirectory()
+    with tmpdir:
+        dpath = ub.Path(tmpdir.name)
+        fpath = dpath / 'job_text.sh'
+        fpath.write_text(bash_text)
+        info = ub.cmd(['bash', '-nv', fpath])
+        if info.returncode != 0:
+            print(info.stderr)
+            raise SyntaxError('bash syntax error')