Update github3.repos.comparison for consistency

sigmavirus24 · sigmavirus24 · commit fca45b030d66 · 2018-03-03T14:17:12.000-06:00
diff --git a/github3/repos/comparison.py b/github3/repos/comparison.py
@@ -1,82 +1,84 @@
 # -*- coding: utf-8 -*-
-"""
-github3.repos.comparison
-========================
-
-This module contains the Comparison object for comparing two commits via the
-GitHub API.
-
-"""
+"""This module contains the Comparison object."""
 from __future__ import unicode_literals
 
 from . import commit
+from .. import models
 
-from ..models import GitHubCore
 
+class Comparison(models.GitHubCore):
+    """A representation of a comparison between two or more commit objects.
 
-class Comparison(GitHubCore):
-    """The :class:`Comparison <Comparison>` object. This encapsulates the
-    information returned by GitHub comparing two commit objects in a
-    repository.
+    See also:
+    http://developer.github.com/v3/repos/commits/#compare-two-commits
 
-    Two comparison instances can be checked like so::
+    This object has the following attributes::
 
-        c1 == c2
-        c1 != c2
+    .. attribute:: ahead_by
 
-    And is equivalent to::
+        The number of commits between the head and base commit.
 
-        c1.commits == c2.commits
-        c1.commits != c2.commits
+    .. attribute:: base_commit
 
-    See also:
-    http://developer.github.com/v3/repos/commits/#compare-two-commits
-    """
+        A :class:`~github3.repos.commit.ShortCommit` representing the base
+        commit in this comparison.
 
-    def _update_attributes(self, compare):
-        self._api = self._get_attribute(compare, 'url')
+    .. attribute:: behind_by
+
+        The number of commits the head commit is behind the base.
+
+    .. attribute:: commits
 
-        #: URL to view the comparison at GitHub
-        self.html_url = self._get_attribute(compare, 'html_url')
+        A list of :class:`~github3.repos.commit.ShortCommit` objects
+        representing the commits in the comparison.
 
-        #: Permanent link to this comparison.
-        self.permalink_url = self._get_attribute(compare, 'permalink_url')
+    .. attribute:: diff_url
 
-        #: URL to see the diff between the two commits.
-        self.diff_url = self._get_attribute(compare, 'diff_url')
+        The URL to retrieve the diff between the head and base commits.
 
-        #: Patch URL at GitHub for the comparison.
-        self.patch_url = self._get_attribute(compare, 'patch_url')
+    .. attribute:: files
 
-        #: :class:`RepoCommit <github3.repos.commit.RepoCommit>` object
-        #: representing the base of comparison.
-        self.base_commit = self._class_attribute(
-            compare, 'base_commit', commit.ShortCommit, None
-        )
+        A list of dictionaries describing each of the modified files in the
+        comparison.
 
-        #: Behind or ahead.
-        self.status = self._get_attribute(compare, 'status')
+    .. attribute:: html_url
 
-        #: Number of commits ahead by.
-        self.ahead_by = self._get_attribute(compare, 'ahead_by')
+        The URL to view the comparison in a browser.
 
-        #: Number of commits behind by.
-        self.behind_by = self._get_attribute(compare, 'behind_by')
+    .. attribute:: patch_url
 
-        #: Number of commits difference in the comparison.
-        self.total_commits = self._get_attribute(compare, 'total_commits')
+        The URL to retrieve the patch-formatted diff of this comparison.
 
-        #: List of :class:`RepoCommit <github3.repos.commit.RepoCommit>`
-        #: objects.
-        self.commits = self._get_attribute(compare, 'commits', [])
+    .. attribute:: permalink_url
+
+        The permanent URL to retrieve this comparison.
+
+    .. attribute:: status
+
+        Whether the head commit is ahead or behind of base.
+
+    .. attribute:: total_commits
+
+        The total number of commits difference.
+    """
+
+    def _update_attributes(self, compare):
+        self._api = compare['url']
+        self.ahead_by = compare['ahead_by']
+        self.base_commit = commit.ShortCommit(compare['base_commit'], self)
+        self.behind_by = compare['behind_by']
+        self.commits = compare['commits']
         if self.commits:
             self.commits = [
                 commit.ShortCommit(com, self) for com in self.commits
             ]
-
-        #: List of dicts describing the files modified.
-        self.files = self._get_attribute(compare, 'files', [])
-
+        self.diff_url = compare['diff_url']
+        self.files = compare['files']
+        self.html_url = compare['html_url']
+        self.patch_url = compare['patch_url']
+        self.permalink_url = compare['permalink_url']
+        self.status = compare['status']
+        self.total_commits = compare['total_commits']
         self._uniq = self.commits
 
     def _repr(self):
@@ -85,8 +87,10 @@ def _repr(self):
     def diff(self):
         """Retrieve the diff for this comparison.
 
-        :returns: the diff as a bytes object
-        :rtype: bytes
+        :returns:
+            the diff as a bytes object
+        :rtype:
+            bytes
         """
         resp = self._get(self._api,
                          headers={'Accept': 'application/vnd.github.diff'})
@@ -95,8 +99,10 @@ def diff(self):
     def patch(self):
         """Retrieve the patch formatted diff for this commit.
 
-        :returns: the patch as a bytes object
-        :rtype: bytes
+        :returns:
+            the patch as a bytes object
+        :rtype:
+            bytes
         """
         resp = self._get(self._api,
                          headers={'Accept': 'application/vnd.github.patch'})
