feat: add a 'to_json()` method to the Gitlab Objects

JohnVillalovos · JohnVillalovos · commit 03d99774ee33 · 2022-02-02T15:02:49.000-08:00
Add a `to_json()` method that returns a JSON string representation of
the object.
diff --git a/docs/api-usage.rst b/docs/api-usage.rst
@@ -193,9 +193,7 @@ You can print a Gitlab Object. For example:
    print(project.pformat())
 
 You can get a dictionary representation copy of the Gitlab Object. Modifications made to
-the dictionary will have no impact on the GitLab Object. This can also be used
-to create a JSON representation of the object. There are two ways to retrieve a
-dictionary representation of the Gitlab Object.
+the dictionary will have no impact on the GitLab Object.
 
  * `asdict()` method. Returns a dictionary representation of the Gitlab object.
  * `attributes` property. Returns a dictionary representation of the Gitlab object.
@@ -213,13 +211,19 @@ dictionary representation of the Gitlab Object.
 
    project = gl.projects.get(1)
    project_dict = project.asdict()
-   # Do a JSON dump of the object
-   print(json.dumps(project.asdict()))
 
    # Or a dictionary representation also containing some of the parent attributes
    issue = project.issues.get(1)
    attribute_dict = issue.attributes
 
+You can get a JSON string represenation of the Gitlab Object. For example:
+
+.. code-block:: python
+
+   project = gl.projects.get(1)
+   print(project.to_json())
+   # Use arguments supported by `json.dump()`
+   print(project.to_json(sort_keys=True, indent=4))
 
 Base types
 ==========
diff --git a/gitlab/base.py b/gitlab/base.py
@@ -17,6 +17,7 @@
 
 import copy
 import importlib
+import json
 import pprint
 import textwrap
 from dataclasses import dataclass
@@ -151,6 +152,9 @@ def asdict(self) -> Dict[str, Any]:
         data.update(copy.deepcopy(self._updated_attrs))
         return data
 
+    def to_json(self, **kwargs: Any) -> str:
+        return json.dumps(self.asdict(), **kwargs)
+
     def __str__(self) -> str:
         return f"{type(self)} => {self.asdict()}"
 
diff --git a/tests/unit/test_base.py b/tests/unit/test_base.py
@@ -298,3 +298,7 @@ def test_attributes(self, fake_manager):
         result["attr1"].append(10)
         assert result == {"attr1": [1, 2, 3, 10]}
         assert fake_object.attributes == {"attr1": [1, 2, 3]}
+
+    def test_to_json(self, fake_manager):
+        fake_object = FakeObject(fake_manager, {"attr1": [1, 2, 3]})
+        assert fake_object.to_json() == '{"attr1": [1, 2, 3]}'
