chore: add the version of python-gitlab to GitlabError

JohnVillalovos · JohnVillalovos · commit 7577c91c5819 · 2022-06-25T10:02:53.000-07:00
People will post tracebacks of exceptions but not post information on
the version of python-gitlab used.

Add the version of python-gitlab to the GitlabError exception message.
diff --git a/gitlab/exceptions.py b/gitlab/exceptions.py
@@ -18,6 +18,10 @@
 import functools
 from typing import Any, Callable, cast, Optional, Type, TYPE_CHECKING, TypeVar, Union
 
+from . import _version as _gl_version
+
+_PG_VERSION = f" (python-gitlab version: {_gl_version.__version__})"
+
 
 class GitlabError(Exception):
     def __init__(
@@ -27,6 +31,10 @@ def __init__(
         response_body: Optional[bytes] = None,
     ) -> None:
 
+        if isinstance(error_message, str):
+            error_message += _PG_VERSION
+        else:
+            error_message += bytes(_PG_VERSION, encoding="ascii")
         Exception.__init__(self, error_message)
         # Http status code
         self.response_code = response_code
diff --git a/tests/unit/test_cli.py b/tests/unit/test_cli.py
@@ -24,8 +24,7 @@
 
 import pytest
 
-from gitlab import cli
-from gitlab.exceptions import GitlabError
+from gitlab import cli, exceptions
 
 
 @pytest.mark.parametrize(
@@ -71,7 +70,7 @@ def test_cls_to_gitlab_resource(class_name, expected_gitlab_resource):
     "message,error,expected",
     [
         ("foobar", None, "foobar\n"),
-        ("foo", GitlabError("bar"), "foo (bar)\n"),
+        ("foo", exceptions.GitlabError("bar"), f"foo (bar{exceptions._PG_VERSION})\n"),
     ],
 )
 def test_die(message, error, expected):
diff --git a/tests/unit/test_exceptions.py b/tests/unit/test_exceptions.py
@@ -6,8 +6,11 @@
 @pytest.mark.parametrize(
     "kwargs,expected",
     [
-        ({"error_message": "foo"}, "foo"),
-        ({"error_message": "foo", "response_code": "400"}, "400: foo"),
+        ({"error_message": "foo"}, f"foo{exceptions._PG_VERSION}"),
+        (
+            {"error_message": "foo", "response_code": "400"},
+            f"400: foo{exceptions._PG_VERSION}",
+        ),
     ],
 )
 def test_gitlab_error(kwargs, expected):

Original file line number	Diff line number	Diff line change
`@@ -24,8 +24,7 @@`
`24`	`24`
`25`	`25`	`import pytest`
`26`	`26`
`27`		`-from gitlab import cli`
`28`		`-from gitlab.exceptions import GitlabError`
	`27`	`+from gitlab import cli, exceptions`
`29`	`28`
`30`	`29`
`31`	`30`	`@pytest.mark.parametrize(`
`@@ -71,7 +70,7 @@ def test_cls_to_gitlab_resource(class_name, expected_gitlab_resource):`
`71`	`70`	`"message,error,expected",`
`72`	`71`	`[`
`73`	`72`	`("foobar", None, "foobar\n"),`
`74`		`- ("foo", GitlabError("bar"), "foo (bar)\n"),`
	`73`	`+ ("foo", exceptions.GitlabError("bar"), f"foo (bar{exceptions._PG_VERSION})\n"),`
`75`	`74`	`],`
`76`	`75`	`)`
`77`	`76`	`def test_die(message, error, expected):`
Original file line number	Diff line number	Diff line change
`@@ -6,8 +6,11 @@`
`6`	`6`	`@pytest.mark.parametrize(`
`7`	`7`	`"kwargs,expected",`
`8`	`8`	`[`
`9`		`- ({"error_message": "foo"}, "foo"),`
`10`		`- ({"error_message": "foo", "response_code": "400"}, "400: foo"),`
	`9`	`+ ({"error_message": "foo"}, f"foo{exceptions._PG_VERSION}"),`
	`10`	`+ (`
	`11`	`+ {"error_message": "foo", "response_code": "400"},`
	`12`	`+ f"400: foo{exceptions._PG_VERSION}",`
	`13`	`+ ),`
`11`	`14`	`],`
`12`	`15`	`)`
`13`	`16`	`def test_gitlab_error(kwargs, expected):`