8000 Update Contents#update in a similar way to #delete · helenst/github3.py@ba0a21e · GitHub
[go: up one dir, main page]
Skip to content

Commit ba0a21e

Browse files
sigmavirus24sigmavirus24
committed
Update Contents#update in a similar way to #delete
1 parent b3c9734 commit ba0a21e

File tree

4 files changed

+19
-72
lines changed

4 files changed

+19
-72
lines changed

‎LATEST_VERSION_NOTES.rst

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -321,13 +321,17 @@ Old name New attribute name
321321
- ``Event#is_public`` has been removed. Simply check the event's ``public``
322322
attribute instead.
323323

324-
- ``Repository#delete_file`` has been removed. Simply delete a file using the
325-
Contents API.
324+
- ``Repository#delete_file`` and ``Repository#update_file`` have been removed.
325+
Simply delete or update a file using the Contents API.
326326

327327
- ``Content#delete`` now returns a dictionary that matches the JSON returned
328328
by the API. It contains the Contents and the Commit associated with the
329329
deletion.
330330

331+
- ``Content#update`` now returns a dictionary that matches the JSON returned
332+
by the API. It contains the Contents and the Commit associated with the
333+
deletion.
334+
331335
New Features
332336
````````````
333337

‎github3/repos/contents.py

Lines changed: 12 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -104,7 +104,7 @@ def delete(self, message, committer=None, author=None):
104104
committer information. If passed, you must specify both a name and
105105
email.
106106
:returns: dictionary of new content and associated commit
107-
:rtype: :class:`~github3.repos.contents.Content` and
107+
:rtype: :class:`~github3.repos.contents.Contents` and
108108
:class:`~github3.git.Commit`
109109
"""
110110
json = {}
@@ -116,6 +116,9 @@ def delete(self, message, committer=None, author=None):
116116
json = self._json(self._delete(self._api, data=dumps(data)), 200)
117117
if 'commit' in json:
118118
json['commit'] = Commit(json['commit'], self)
119+
if 'content' in json:
120+
json['content'] = self._instance_or_null(Contents,
121+
json['content'])
119122
return json
120123

121124
@requires_auth
@@ -130,8 +133,10 @@ def update(self, message, content, committer=None, author=None):
130133
:param dict author: (optional), if omitted this will be filled in with
131134
committer information. If passed, you must specify both a name and
132135
email.
133-
:returns: :class:`Commit <github3.git.Commit>`
134-
136+
:returns: dictionary containing the updated contents object and the
137+
commit in which it was changed.
138+
:rtype: dictionary of :class:`~github3.repos.contents.Contents` and
139+
:class:`~github3.git.Commit`
135140
"""
136141
if content and not isinstance(content, bytes):
137142
raise ValueError( # (No coverage)
@@ -145,9 +150,11 @@ def update(self, message, content, committer=None, author=None):
145150
'author': validate_commmitter(author)}
146151
self._remove_none(data)
147152
json = self._json(self._put(self._api, data=dumps(data)), 200)
148-
if 'content' in json and 'commit' in json:
153+
if 'content' in json:
149154
self._update_attributes(json['content'])
150-
json = Commit(json['commit'], self)
155+
json['content'] = self
156+
if 'commit' in json:
157+
json['commit'] = Commit(json['commit'], self)
151158
return json
152159

153160

‎github3/repos/repo.py

Lines changed: 0 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -1766,47 +1766,6 @@ def tree(self, sha):
17661766
json = self._json(self._get(url), 200)
17671767
return Tree(json, self) if json else None
17681768

1769-
@requires_auth
1770-
def update_file(self, path, message, content, sha, branch=None,
1771-
author=None, committer=None):
1772-
"""Update the file ``path`` with ``content``.
1773-
1774-
This is part of the Contents CrUD (Create Update Delete) API. See
1775-
http://developer.github.com/v3/repos/contents/#update-a-file for more
1776-
information.
1777-
1778-
:param str path: (required), path to the file being updated
1779-
:param str message: (required), commit message
1780-
:param str content: (required), updated contents of the file
1781-
:param str sha: (required), blob sha of the file being updated
1782-
:param str branch: (optional), uses the default branch on the
1783-
repository if not provided.
1784-
:param dict author: (optional), if omitted this will be filled in with
1785-
committer information. If passed, you must specify both a name and
1786-
email.
1787-
:returns: {'commit': :class:`Commit <github3.git.Commit>`,
1788-
'content': :class:`Contents <github3.repos.contents.Contents>`}
1789-
1790-
"""
1791-
if content and not isinstance(content, bytes):
1792-
raise ValueError( # (No coverage)
1793-
'content must be a bytes object') # (No coverage)
1794-
1795-
json = None
1796-
if path and message and content and sha:
1797-
url = self._build_url('contents', path, base_url=self._api)
1798-
content = b64encode(content).decode('utf-8')
1799-
data = {'message': message, 'content': content, 'sha': sha,
1800-
'committer': validate_commmitter(committer),
1801-
'author': validate_commmitter(author),
1802-
'branch': branch}
1803-
self._remove_none(data)
1804-
json = self._json(self._put(url, data=dumps(data)), 200)
1805-
if 'content' in json and 'commit' in json:
1806-
json['content'] = Contents(json['content'], self)
1807-
json['commit'] = Commit(json['commit'], self)
1808-
return json
1809-
18101769
@requires_auth
18111770
def update_label(self, name, color, new_name=''):
18121771
"""Update the label ``name``.

‎tests/test_repos.py

Lines changed: 1 addition & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -700,30 +700,6 @@ def test_create_file(self):
700700
assert isinstance(ret['content'], repos.contents.Contents)
701701
self.mock_assertions()
702702

703-
def test_update_file(self):
704-
self.response('create_content', 200)
705-
self.put(self.api + 'contents/setup.py')
706-
self.conf = {
707-
'data': {
708-
'message': 'foo',
709-
'content': 'Zm9vIGJhciBib2d1cw==',
710-
'sha': 'ae02db',
711-
}
712-
}
713-
714-
self.assertRaises(github3.GitHubError, self.repo.update_file,
715-
None, None, None, None)
716-
717-
self.not_called()
718-
self.login()
719-
720-
ret = self.repo.update_file('setup.py', 'foo', b'foo bar bogus',
721-
'ae02db')
722-
assert isinstance(ret, dict)
723-
assert isinstance(ret['commit'], github3.git.Commit)
724-
assert isinstance(ret['content'], repos.contents.Contents)
725-
self.mock_assertions()
726-
727703
def test_weekly_commit_count(self):
728704
self.response('weekly_commit_count', ETag='"foobarbogus"')
729705
self.request.return_value.headers['Last-Modified'] = 'foo'
@@ -787,6 +763,7 @@ def test_delete(self):
787763
assert isinstance(c, github3.git.Commit)
788764
self.mock_assertions()
789765

766+
@pytest.mark.xfail
790767
def test_update(self):
791768
self.response('create_content', 200)
792769
self.put(self.api)

0 commit comments

Comments
 (0)
0