From 76590aa4080d125084a110a496505d485ef75ceb Mon Sep 17 00:00:00 2001
From: David Pursehouse <david.pursehouse@sonymobile.com>
Date: Tue, 10 Sep 2013 20:03:23 +0900
Subject: Add __repr__ methods on event and model classes

This gives more meaningful output when doing:

  print(event)

and means it's not necessary to use str(event).

Change-Id: I3c1546ab89c481bec24fbc4445ed7f33aa05eff8
---
 pygerrit/events.py | 36 +++++++++++++++++++++++++++++++++---
 pygerrit/models.py | 17 +++++++++++++++++
 2 files changed, 50 insertions(+), 3 deletions(-)

(limited to 'pygerrit')

diff --git a/pygerrit/events.py b/pygerrit/events.py
index 8a5c21f..e563a7a 100644
--- a/pygerrit/events.py
+++ b/pygerrit/events.py
@@ -81,9 +81,6 @@ class GerritEvent(object):
     def __init__(self):
         pass
 
-    def __str__(self):
-        return u"%s" % self.name  # pylint: disable=no-member
-
 
 @GerritEventFactory.register("patchset-created")
 class PatchsetCreatedEvent(GerritEvent):
@@ -99,6 +96,11 @@ class PatchsetCreatedEvent(GerritEvent):
         except KeyError as e:
             raise GerritError("PatchsetCreatedEvent: %s" % e)
 
+    def __repr__(self):
+        return u"<PatchsetCreatedEvent>: %s %s %s" % (self.change,
+                                                      self.patchset,
+                                                      self.uploader)
+
 
 @GerritEventFactory.register("draft-published")
 class DraftPublishedEvent(GerritEvent):
@@ -114,6 +116,11 @@ class DraftPublishedEvent(GerritEvent):
         except KeyError as e:
             raise GerritError("DraftPublishedEvent: %s" % e)
 
+    def __repr__(self):
+        return u"<DraftPublishedEvent>: %s %s %s" % (self.change,
+                                                     self.patchset,
+                                                     self.uploader)
+
 
 @GerritEventFactory.register("comment-added")
 class CommentAddedEvent(GerritEvent):
@@ -134,6 +141,11 @@ class CommentAddedEvent(GerritEvent):
         except (KeyError, ValueError) as e:
             raise GerritError("CommentAddedEvent: %s" % e)
 
+    def __repr__(self):
+        return u"<CommentAddedEvent>: %s %s %s" % (self.change,
+                                                   self.patchset,
+                                                   self.author)
+
 
 @GerritEventFactory.register("change-merged")
 class ChangeMergedEvent(GerritEvent):
@@ -149,6 +161,11 @@ class ChangeMergedEvent(GerritEvent):
         except KeyError as e:
             raise GerritError("ChangeMergedEvent: %s" % e)
 
+    def __repr__(self):
+        return u"<ChangeMergedEvent>: %s %s %s" % (self.change,
+                                                   self.patchset,
+                                                   self.submitter)
+
 
 @GerritEventFactory.register("change-abandoned")
 class ChangeAbandonedEvent(GerritEvent):
@@ -165,6 +182,11 @@ class ChangeAbandonedEvent(GerritEvent):
         except KeyError as e:
             raise GerritError("ChangeAbandonedEvent: %s" % e)
 
+    def __repr__(self):
+        return u"<ChangeAbandonedEvent>: %s %s %s" % (self.change,
+                                                      self.patchset,
+                                                      self.abandoner)
+
 
 @GerritEventFactory.register("change-restored")
 class ChangeRestoredEvent(GerritEvent):
@@ -181,6 +203,11 @@ class ChangeRestoredEvent(GerritEvent):
         except KeyError as e:
             raise GerritError("ChangeRestoredEvent: %s" % e)
 
+    def __repr__(self):
+        return u"<ChangeRestoredEvent>: %s %s %s" % (self.change,
+                                                     self.patchset,
+                                                     self.restorer)
+
 
 @GerritEventFactory.register("ref-updated")
 class RefUpdatedEvent(GerritEvent):
@@ -194,3 +221,6 @@ class RefUpdatedEvent(GerritEvent):
             self.submitter = Account.from_json(json_data, "submitter")
         except KeyError as e:
             raise GerritError("RefUpdatedEvent: %s" % e)
+
+    def __repr__(self):
+        return u"<RefUpdatedEvent>: %s %s" % (self.ref_update, self.submitter)
diff --git a/pygerrit/models.py b/pygerrit/models.py
index 2e79949..ac9575a 100644
--- a/pygerrit/models.py
+++ b/pygerrit/models.py
@@ -34,6 +34,10 @@ class Account(object):
         self.name = from_json(json_data, "name")
         self.email = from_json(json_data, "email")
 
+    def __repr__(self):
+        return u"<Account %s%s>" % (self.name,
+                                    " (%s)" % self.email if self.email else "")
+
     @staticmethod
     def from_json(json_data, key):
         """ Create an Account instance.
@@ -61,6 +65,9 @@ class Change(object):
         self.url = from_json(json_data, "url")
         self.owner = Account.from_json(json_data, "owner")
 
+    def __repr__(self):
+        return u"<Change %s, %s, %s>" % (self.number, self.project, self.branch)
+
 
 class Patchset(object):
 
@@ -72,6 +79,9 @@ class Patchset(object):
         self.ref = from_json(json_data, "ref")
         self.uploader = Account.from_json(json_data, "uploader")
 
+    def __repr__(self):
+        return u"<Patchset %s, %s>" % (self.number, self.revision)
+
     @staticmethod
     def from_json(json_data):
         r""" Create a Patchset instance.
@@ -94,6 +104,9 @@ class Approval(object):
         self.value = from_json(json_data, "value")
         self.description = from_json(json_data, "description")
 
+    def __repr__(self):
+        return u"<Approval %s %s>" % (self.description, self.value)
+
 
 class RefUpdate(object):
 
@@ -104,3 +117,7 @@ class RefUpdate(object):
         self.newrev = from_json(json_data, "newRev")
         self.refname = from_json(json_data, "refName")
         self.project = from_json(json_data, "project")
+
+    def __repr__(self):
+        return "<RefUpdate %s %s %s %s>" % \
+            (self.project, self.refname, self.oldrev, self.newrev)
-- 
cgit v1.2.1