Show a maximum of 20 characters in a string's repr() output.

JNRowe · JNRowe · commit 9bfcb161f6fe · 2011-06-11T08:42:26.000+01:00
diff --git a/github2/commits.py b/github2/commits.py
@@ -1,4 +1,5 @@
-from github2.core import BaseData, GithubCommand, Attribute, DateAttribute
+from github2.core import (BaseData, GithubCommand, Attribute, DateAttribute,
+                          repr_string)
 
 
 class Commit(BaseData):
@@ -20,7 +21,7 @@ class Commit(BaseData):
                          "been modified since last commit.")
 
     def __repr__(self):
-        return "<Commit: %s %s>" % (self.id[:8], self.message[:64])
+        return "<Commit: %s %s>" % (self.id[:8], repr_string(self.message))
 
 
 class Commits(GithubCommand):
diff --git a/github2/core.py b/github2/core.py
@@ -245,3 +245,14 @@ def iterate(self):
 
 class BaseData(object):
     __metaclass__ = BaseDataType
+
+
+def repr_string(string):
+    """Shorten string for use in repr() output
+
+    :param str string: string to operate on
+    :return: string, with maximum length of 20 characters
+    """
+    if len(string) > 20:
+        string = string[:17] + '...'
+    return string.encode('utf-8')
diff --git a/github2/issues.py b/github2/issues.py
@@ -1,6 +1,7 @@
 import urllib
 
-from github2.core import GithubCommand, BaseData, Attribute, DateAttribute
+from github2.core import (GithubCommand, BaseData, Attribute, DateAttribute,
+                          repr_string)
 
 
 class Issue(BaseData):
@@ -20,7 +21,7 @@ class Issue(BaseData):
     pull_request_url = Attribute("URL for the issue's related pull request.")
 
     def __repr__(self):
-        return "<Issue: %s>" % self.title.encode('utf-8')
+        return "<Issue: %s>" % repr_string(self.title)
 
 
 class Comment(BaseData):
@@ -31,7 +32,7 @@ class Comment(BaseData):
     user = Attribute("The username of the user that created this comment.")
 
     def __repr__(self):
-        return "<Comment: %s>" % self.body
+        return "<Comment: %s>" % repr_string(self.body)
 
 
 class Issues(GithubCommand):
diff --git a/github2/pull_requests.py b/github2/pull_requests.py
@@ -1,4 +1,5 @@
-from github2.core import BaseData, GithubCommand, Attribute, DateAttribute
+from github2.core import (BaseData, GithubCommand, Attribute, DateAttribute,
+                          repr_string)
 
 
 class PullRequest(BaseData):
@@ -35,7 +36,7 @@ class PullRequest(BaseData):
     mergeable = Attribute("Whether the pull request can be merge cleanly")
 
     def __repr__(self):
-        return "<PullRequest: %s>" % self.title.encode('utf-8')
+        return "<PullRequest: %s>" % repr_string(self.title)
 
 
 class PullRequests(GithubCommand):
diff --git a/tests/test_unit.py b/tests/test_unit.py
@@ -8,6 +8,7 @@
 
 from nose.tools import (assert_equals, assert_true)
 
+from github2.core import repr_string
 from github2.issues import Issue
 from github2.client import Github
 
@@ -48,3 +49,8 @@ def test_project_for_user_repo():
     client = Github()
     assert_equals(client.project_for_user_repo('JNRowe', 'misc-overlay'),
                   'JNRowe/misc-overlay')
+
+def test_repr_string():
+    assert_equals(repr_string('test'), 'test')
+    assert_equals(repr_string('abcdefghijklmnopqrst'), 'abcdefghijklmnopqrst')
+    assert_equals(repr_string('abcdefghijklmnopqrstu'), 'abcdefghijklmnopq...')
