mirror
/
borg
mirror of https://github.com/borgbackup/borg.git
1
0
Fork 0
Code Issues Releases Wiki Activity

BORG_EXIT_CODES=modern can be set to get more specific process exit codes 

If not set, it will default to "legacy" (always return 2 for errors).

This commit only changes the Error exception class and its subclasses.

The more specific exit codes need to be defined via .exit_mcode in the subclasses.
This commit is contained in:
Thomas Waldmann 2023-11-09 05:40:34 +01:00
parent 0e859a6d2d
commit 1b09d0efd7
No known key found for this signature in database
GPG Key ID: 243ACFA951F78E01
1 changed files with 12 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
src/borg/helpers/errors.py
View File

@ -1,3 +1,5 @@
import os
from ..constants import * # NOQA
from ..crypto.low_level import IntegrityError as IntegrityErrorBase
@ -10,8 +12,9 @@ class Error(Exception):
# if we raise such an Error and it is only caught by the uppermost
# exception handler (that exits short after with the given exit_code),
# it is always a (fatal and abrupt) EXIT_ERROR, never just a warning.
exit_code = EXIT_ERROR
# it is always a (fatal and abrupt) error, never just a warning.
exit_mcode = EXIT_ERROR # modern, more specific exit code (defaults to EXIT_ERROR)
# show a traceback?
traceback = False
@ -24,6 +27,13 @@ class Error(Exception):
__str__ = get_message
@property
def exit_code(self):
# legacy: borg used to always use rc 2 (EXIT_ERROR) for all errors.
# modern: users can opt in to more specific return codes, using BORG_RC_STYLE:
modern = os.environ.get("BORG_EXIT_CODES", "legacy") == "modern"
return self.exit_mcode if modern else EXIT_ERROR
class ErrorWithTraceback(Error):
"""Error: {}"""