exceptions: ensure ProcessExecutionError can be pickled (#586)

* exceptions: ensure ProcessExecutionError can be pickled * fix: EnvironmentError is OSError in Python 3 * Update plumbum/commands/processes.py Co-authored-by: Henry Schreiner <[email protected]>
tomerfiliba · Feb 3, 2022 · ba4b1a0 · ba4b1a0
1 parent 7bba255
commit ba4b1a0
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 2 deletions.
diff --git a/plumbum/commands/processes.py b/plumbum/commands/processes.py
@@ -106,15 +106,19 @@ def run(self):
 # ===================================================================================================
 # Exceptions
 # ===================================================================================================
-class ProcessExecutionError(EnvironmentError):
+class ProcessExecutionError(OSError):
     """Represents the failure of a process. When the exit code of a terminated process does not
     match the expected result, this exception is raised by :func:`run_proc
     <plumbum.commands.run_proc>`. It contains the process' return code, stdout, and stderr, as
     well as the command line used to create the process (``argv``)
     """
 
     def __init__(self, argv, retcode, stdout, stderr, message=None):
-        super().__init__(self, argv, retcode, stdout, stderr)
+
+        # we can't use 'super' here since OSError only keeps the first 2 args,
+        # which leads to failuring in loading this object from a pickle.dumps.
+        Exception.__init__(self, argv, retcode, stdout, stderr)
+
         self.message = message
         self.argv = argv
         self.retcode = retcode

diff --git a/tests/test_local.py b/tests/test_local.py
@@ -724,6 +724,13 @@ def test_quoting(self):
             ls("-a", "")  # check that empty strings are rendered correctly
         assert execinfo.value.argv[-2:] == ["-a", ""]
 
+    def test_exception_pickling(self):
+        import pickle
+
+        with pytest.raises(ProcessExecutionError) as exc_info:
+            local.cmd.ls("no-file")
+        assert pickle.loads(pickle.dumps(exc_info.value)).argv == exc_info.value.argv
+
     def test_tempdir(self):
         with local.tempdir() as dir:
             assert dir.is_dir()