Merge pull request #74 from dmerejkowsky/fatal-exit-code

Fatal exit code

Author: dmerejkowsky

cli_ui/__init__.py

@@ -252,10 +252,15 @@ def message(
     write_and_flush(fileobj, to_write)
 
 
-def fatal(*tokens: Token, **kwargs: Any) -> None:
-    """Print an error message and call ``sys.exit``"""
+def fatal(*tokens: Token, exit_code: int = 1, **kwargs: Any) -> None:
+    """Print an error message and exit the program
+
+    :param tokens: list of `ui` constants or strings, like
+                   ``(cli_ui.red, "this is a fatal  error")``
+    :param exit_code: value of the exit code (default: 1)
+    """
     error(*tokens, **kwargs)
-    sys.exit(1)
+    sys.exit(exit_code)
 
 
 def error(*tokens: Token, **kwargs: Any) -> None:

cli_ui/tests/test_cli_ui.py

@@ -331,6 +331,20 @@ def test_quiet(message_recorder: MessageRecorder) -> None:
     assert not message_recorder.find("info")
 
 
+def test_fatal() -> None:
+    cli_ui.setup(quiet=True)
+    with pytest.raises(SystemExit) as e:
+        cli_ui.fatal("default exit code")
+    assert e.value.code == 1
+
+
+def test_fatal_with_custom_code() -> None:
+    cli_ui.setup(quiet=True)
+    with pytest.raises(SystemExit) as e:
+        cli_ui.fatal("custom exit code", exit_code=3)
+    assert e.value.code == 3
+
+
 def test_color_always(dumb_tty: DumbTTY) -> None:
     cli_ui.setup(color="always")
     cli_ui.info(cli_ui.red, "this is red", fileobj=dumb_tty)

docs/changelog.rst

@@ -1,6 +1,12 @@
 Changelog
 ----------
 
+unreleased
+++++++++++
+
+* `fatal` can now be called with a custom exit code, different than
+  the default 1.
+
 v0.14.1 (2021-06-06)
 ++++++++++++++++++++
 

docs/index.rst

@@ -194,7 +194,11 @@ Functions below use ``sys.stderr`` by default:
 
       >>> cli_ui.fatal("Message")
       Error: message
-      exit()
+      exit(1)
+
+      >>> cli_ui.fatal("Another message", exit_code=2)
+      Error: Another message
+      exit(2)
 
 
 Progress messages