chore: add the version of python-gitlab to Exception

JohnVillalovos · JohnVillalovos · commit f6028e630750 · 2022-06-24T17:42:53.000-07:00
People will post tracebacks of AttributeError exceptions but not post
information on the version of python-gitlab used.

Add the version of python-gitlab to the AttributeError exception
message.
diff --git a/gitlab/base.py b/gitlab/base.py
@@ -129,6 +129,7 @@ def __getattr__(self, name: str) -> Any:
                 except KeyError as exc:
                     message = (
                         f"{type(self).__name__!r} object has no attribute {name!r}"
+                        f" (python-gitlab version: {gitlab.__version__})"
                     )
                     if self._created_from_list:
                         message = (
diff --git a/tests/unit/test_base.py b/tests/unit/test_base.py
@@ -103,6 +103,16 @@ def test_missing_attribute_does_not_raise_custom(self, fake_gitlab, fake_manager
         assert "was created via a list()" not in exc_str
         assert base._URL_ATTRIBUTE_ERROR not in exc_str
 
+    def test_missing_attribute_has_pg_version(self, fake_gitlab, fake_manager):
+        """Ensure a missing attribute raise our custom error message with the
+        version of python-gitlab"""
+        obj = FakeObject(manager=fake_manager, attrs={"foo": "bar"})
+        with pytest.raises(AttributeError) as excinfo:
+            obj.missing_attribute
+        exc_str = str(excinfo.value)
+        pg_version_str = f"(python-gitlab version: {gitlab.__version__})"
+        assert pg_version_str in exc_str
+
     def test_missing_attribute_from_list_raises_custom(self, fake_gitlab, fake_manager):
         """Ensure a missing attribute raises our custom error message if the
         RESTObject was created from a list"""

Original file line number	Diff line number	Diff line change
`@@ -129,6 +129,7 @@ def __getattr__(self, name: str) -> Any:`
`129`	`129`	`except KeyError as exc:`
`130`	`130`	`message = (`
`131`	`131`	`f"{type(self).__name__!r} object has no attribute {name!r}"`
	`132`	`+ f" (python-gitlab version: {gitlab.__version__})"`
`132`	`133`	`)`
`133`	`134`	`if self._created_from_list:`
`134`	`135`	`message = (`