jolt 0.9.123__py3-none-any.whl → 0.9.435__py3-none-any.whl

jolt/__init__.py

@@ -1,3 +1,7 @@
+from .error import JoltError
+from .error import JoltCommandError
+from .error import JoltTimeoutError
+
 from .tasks import Alias
 from .tasks import BooleanParameter
 from .tasks import Chroot
@@ -35,6 +39,9 @@ __all__ = (
     "EnvironExport",
     "Export",
     "IntParameter",
+    "JoltError",
+    "JoltCommandError",
+    "JoltTimeoutError",
     "ListParameter",
     "MultiTask",
     "Parameter",
@@ -54,16 +61,82 @@ __all__ = (
 name = "jolt"
 
 
-def include(joltfile):
-    """ Include another Python file """
+def include(joltfile, joltdir=None):
+    """ Include another Python file with Jolt tasks.
+
+      :param joltfile: The path to the Jolt file to include.
+      :type joltfile: str
+
+      :param joltdir: The directory to search for Jolt files.
+      :type joltdir: str
+
+    Example:
+
+      .. code-block:: python
+
+            from jolt import include
+
+            include("joltfile.py")
+
+      """
     try:
         from os import path
-        from sys import _getframe
         from jolt.loader import JoltLoader
-        filepath = _getframe().f_back.f_code.co_filename
-        filepath = path.dirname(filepath)
-        filepath = path.join(filepath, joltfile)
-        JoltLoader.get()._load_file(filepath)
+        import sys
+        caller_dir = path.dirname(sys._getframe().f_back.f_code.co_filename)
+        if joltdir is not None:
+            joltdir = path.join(caller_dir, joltdir)
+        else:
+            joltdir = caller_dir
+        filepath = path.join(caller_dir, joltfile)
+        JoltLoader.get().load_file(filepath, joltdir=joltdir)
     except Exception as e:
         from jolt.error import raise_error
         raise_error("Failed to load '{0}': {1}", joltfile, str(e))
+
+
+def require_resource(name: str, ):
+    """ Require a resource task.
+
+    Args:
+        name (str): The name of the resource task.
+
+    Example:
+
+      .. code-block:: python
+
+            from jolt import require_resource
+
+            require_resource("git:url=https://github.com/srand/jolt.git")
+
+      """
+    from jolt.tasks import TaskRegistry
+    registry = TaskRegistry.get()
+    registry.require_workspace_resource(name)
+
+
+def require_version(verstr: str):
+    """ Require a specific version of Jolt.
+
+    Args:
+        verstr (str): The version to require. Must be a string.
+            Operators such as ``>=`` and ``<=`` are supported.
+
+    Example:
+
+      .. code-block:: python
+
+            from jolt import require_version
+
+            require_version("1.0.0")
+
+      """
+    from jolt.error import raise_error_if
+    from jolt.version_utils import requirement, version
+
+    req = requirement(verstr)
+    ver = version(__version__)
+    raise_error_if(
+        not req.satisfied(ver),
+        "This project requires Jolt version {} (running {})",
+        req, __version__)

jolt/__main__.py

@@ -3,6 +3,7 @@ import os
 import sys
 
 from jolt import cli
+from jolt import error
 from jolt import log
 
 
@@ -38,8 +39,15 @@ def main():
             extype, value, tb = sys.exc_info()
             pdb.post_mortem(tb)
         sys.exit(1)
+    except error.LoggedJoltError as e:
+        log.error(log.format_exception_msg(e.exc))
+        if cli.debug_enabled:
+            import pdb
+            extype, value, tb = sys.exc_info()
+            pdb.post_mortem(tb)
+        sys.exit(1)
     except Exception as e:
-        log.exception(e)
+        log.exception(e, error=True)
         if cli.debug_enabled:
             import pdb
             extype, value, tb = sys.exc_info()