Rename method getcomments to get_comments for better readablity (#226)

mrbahrani · abahrani97 · crazyscientist · web-flow · commit adf33b6239c3 · 2024-10-30T09:59:02.000+01:00
Using the api, I used to think the only way to retrieve the comments is
to go through a Bugzilla instance. Later, I figured out the the Bug
objects have the method `get_attachments` and I was amazed that there is
no `get_comments`. Digging into the code I realized the method has been
named `getcomments`. I have changed all the occurrences of `getcomments`
method of the Bug class to `get_comment`

---------

Co-authored-by: abahrani &lt;abahrani@starfishmedical.com&gt;
Co-authored-by: Andreas Hasenkopf &lt;andreas@hasenkopf.xyz&gt;
diff --git a/bugzilla/bug.py b/bugzilla/bug.py
@@ -292,14 +292,14 @@ def addcomment(self, comment, private=False):
 
         return self.bugzilla.update_bugs(self.bug_id, vals)
 
-    def getcomments(self):
+    def get_comments(self):
         """
         Returns an array of comment dictionaries for this bug
         """
         comment_list = self.bugzilla.get_comments([self.bug_id])
         return comment_list['bugs'][str(self.bug_id)]['comments']
 
-
+    getcomments = get_comments
     #####################
     # Get/Set bug flags #
     #####################
diff --git a/examples/getbug.py b/examples/getbug.py
@@ -33,8 +33,8 @@
 
 # comments must be fetched separately on stock bugzilla. this just returns
 # a raw dict with all the info.
-comments = bug.getcomments()
+comments = bug.get_comments()
 print("\nLast comment data:\n%s" % pprint.pformat(comments[-1]))
 
-# getcomments is just a wrapper around bzapi.get_comments(), which can be
+# get_comments is just a wrapper around bzapi.get_comments(), which can be
 # used for bulk comments fetching
diff --git a/examples/update.py b/examples/update.py
@@ -38,15 +38,15 @@
 
 
 # Now let's add a comment
-comments = bug.getcomments()
+comments = bug.get_comments()
 print("Bug originally has %d comments" % len(comments))
 
 update = bzapi.build_update(comment="new example comment %s" % time.time())
 bzapi.update_bugs([bug.id], update)
 
 # refresh() actually isn't required here because comments are fetched
 # on demand
-comments = bug.getcomments()
+comments = bug.get_comments()
 print("Bug now has %d comments. Last comment=%s" % (len(comments),
     comments[-1]["text"]))
 
diff --git a/tests/test_api_bug.py b/tests/test_api_bug.py
@@ -200,6 +200,7 @@ def _get_fake_bug(apiname):
     # Stub API testing
     bug = fakebz.getbug(1165434)
     bug.get_history_raw()
+    bug.get_comments()
     bug.getcomments()
 
     # Some hackery to hit a few attachment code paths
diff --git a/tests/test_rw_functional.py b/tests/test_rw_functional.py
@@ -318,8 +318,11 @@ def test05ModifyStatus(run_cli, backends):
     assert bug.longdescs[-1]["text"] == comment
     assert bug.longdescs[-1]["is_private"] == 0
 
-    # Confirm comments is same as getcomments
+    # Confirm comments is same as get_comments
+    assert bug.comments == bug.get_comments()
+    # This method will be removed in a future version
     assert bug.comments == bug.getcomments()
+    assert bug.get_comments() == bug.getcomments()
 
     # Reset state
     run_cli(cmd + "--status %s" % origstatus, bz)
