Add Release.assets attribute

bgilbert · bgilbert · commit 47cba939175d · 2014-05-02T02:08:14.000-04:00
The JSON describing a release includes complete information on its
assets.  Add Release.assets attribute with a list of Assets.  This is
cheaper for the application than making a separate request via
Release.iter_assets().

Leave Release.iter_assets() in place, in case someone has a use for it,
but mention Release.assets in its documentation.
diff --git a/github3/repos/release.py b/github3/repos/release.py
@@ -22,6 +22,8 @@ class Release(GitHubCore):
     def __init__(self, release, session=None):
         super(Release, self).__init__(release, session)
         self._api = release.get('url')
+        #: List of :class:`Asset <Asset>` objects for this release
+        self.assets = [Asset(i, self) for i in release.get('assets', [])]
         #: URL for uploaded assets
         self.assets_url = release.get('assets_url')
         #: Body of the release (the description)
@@ -104,7 +106,9 @@ def edit(self, tag_name=None, target_commitish=None, name=None, body=None,
         return successful
 
     def iter_assets(self, number=-1, etag=None):
-        """Iterate over the assets available for this release.
+        """Iterate over the assets available for this release.  The same
+        information is available, without an additional network access,
+        from the :attr:`assets` attribute.
 
         :param int number: (optional), Number of assets to return
         :param str etag: (optional), last ETag header sent
diff --git a/tests/unit/test_repos_release.py b/tests/unit/test_repos_release.py
@@ -15,6 +15,18 @@ class TestRelease(UnitHelper):
     example_data = {
         "url": releases_url("/1"),
         "html_url": "https://github.com/octocat/Hello-World/releases/v1.0.0",
+        "assets": [{
+            "url": releases_url("/assets/1"),
+            "id": 1,
+            "name": "example.zip",
+            "label": "short description",
+            "state": "uploaded",
+            "content_type": "application/zip",
+            "size": 1024,
+            "download_count": 42,
+            "created_at": "2013-02-27T19:35:32Z",
+            "updated_at": "2013-02-27T19:35:32Z"
+            }],
         "assets_url": releases_url("/1/assets"),
         "upload_url": releases_url("/1/assets{?name}"),
         "id": 1,
@@ -29,6 +41,10 @@ class TestRelease(UnitHelper):
         }
 
     # Attribute tests
+    def test_assets(self):
+        assert self.instance.assets is not None
+        assert isinstance(self.instance.assets[0], Asset)
+
     def test_has_upload_urlt(self):
         assert self.instance.upload_urlt is not None
 
