Skip to content

Commit 8d98882

Browse files
sigmavirus24sigmavirus24
committed
Handle exceptional case in directory_contents
In the event a user calls Repository.directory_contents with a file or non-directory argument, let's handle the response and raise an appropriate, UnprocessableResponse for the user to handle. Closes sigmavirus24gh-830
1 parent 7c87834 commit 8d98882

3 files changed

Lines changed: 19 additions & 0 deletions

File tree

‎github3/repos/repo.py‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@
1313
import uritemplate as urit
1414

1515
from .. import events
16+
from .. import exceptions
1617
from .. import git
1718
from .. import issues
1819
from ..issues import event as ievent
@@ -1164,9 +1165,18 @@ def directory_contents(self, directory_path, ref=None, return_as=list):
11641165
list of tuples of the filename and the Contents returned
11651166
:rtype:
11661167
[(str, :class:`~github3.repos.contents.Contents`)]
1168+
:raises github3.exceptions.UnprocessableResponseBody:
1169+
When the requested directory is not actually a directory
11671170
"""
11681171
url = self._build_url('contents', directory_path, base_url=self._api)
11691172
json = self._json(self._get(url, params={'ref': ref}), 200) or []
1173+
if not (isinstance(json, list) and
1174+
all(isinstance(j, dict) for j in json)):
1175+
raise exceptions.UnprocessableResponseBody(
1176+
'The contents returned do not appear to be a directory. '
1177+
'You may have requested a non-directory.',
1178+
json
1179+
)
11701180
return return_as((j.get('name'), contents.Contents(j, self))
11711181
for j in json)
11721182

‎tests/cassettes/Repository_not_really_directory_contents.json‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
{"http_interactions": [{"request": {"body": {"encoding": "utf-8", "string": ""}, "headers": {"User-Agent": "github3.py/1.1.0", "Accept-Encoding": "gzip, deflate", "Accept": "application/vnd.github.v3.full+json", "Connection": "keep-alive", "Accept-Charset": "utf-8", "Content-Type": "application/json"}, "method": "GET", "uri": "https://api.github.com/repos/sigmavirus24/github3.py"}, "response": {"body": {"encoding": "utf-8", "base64_string": "H4sIAAAAAAAAA62YwZKjNhCGX4Xisod4wDZ27KEqtckhlZ1TtpLJJReXDDIoA4iShB0vNe+eXxJgcNXaM6NcPDaj/vSrpW661fos9eNos5hvFouZX5GS+rGfMZU3+yioz/7MPzRFsev+IVlWkiMTjVyuwskofqqo8OPWL3jGKjDGQ0HR0yxX8200n/nkSBQRu0YUGJcrVcs4DO1DGQUW20gqEl4pWqkg4WXYhNb68/GnFXCZ6CCa6+PBFaxmHccaAybDK0W5KosrDXZqY3I1+MCLgp9AuVZ9b6JwsNSuNBRWZR+kwLINucopnIclvWpHMKneL8pYtdhBqXYs1RyJHRE0fbewzg6y9AF4bUNBa26AzV4mgtWK8er9AifWoHGRkYp9Ix+jwVoCoqW9X4qxgjU94iy+39yatWEt2JEkZ+0aQRPKjnD2B5FX9iCqc63j9i8cCu16puiOpKWOwwMpJH2d+WZ6hUHmwQxh99bTP43zlA67igm/sJn39Kn0iFewvSDi7B248BjCVpBE4bh6J6QS77cn9aXZf5LeH7/++ez98vUJQ2CD+IZPGdzqkSr1qMh4xUuWeCdyDrwn78TFi8cr7+tZ5fizDDYzLwpW+mM9MyZR8CPWizlfhoXdTARmLyexPV2dJt3Z4psIRDsAkPRCz04cbd+G+OzCM0HmIHsuiOL3ctBtgRNQG45/6qOpKCmdhBsAQDnnbp40AICYlA19U6TcXrjhyLAPx6op9zaDviUIb6MtAVqJxGujotTJgwOkDfskj9CqktwN2zPa0H4zu00yJ6naHph9wfdOHLx3QwNpQ5kT+1pTO1d1mqoZE6igB2epmjFAlXDcbyNTQwYk3qkKW++ks2eEbefRglRZQzI36gDBrus3f0a+3a2JbsfOhQKkLvgE2zfuSe7C0UptKYJ4d3PpBXOBmvrmdtV0xwGjOsm4oCzZvTLjNrFDTI79/4DV5/QarX/fr4ruy9WMNrzkZJv0O7qLd7us3+scz9F1F05HomeE7Q81UbnOXJiqJoK6iO4QYbsnqN2CIGhzSkyVXqJGcotgSwCKiCRHEeqis+0ZqHpKokzxf9AyUzQDBSepk28HCIB2G120WsJ4/2v0tU4CDWBMLFlBpeKV4w4NlDG74oodWPKWBuh2uE1A7WfJqoTOSFHMcGoVSxjOMep2vYsoOKmbhywBy8C1gm18Cooj7eR1QS2jDW3jmtK64GfnLDTC6CAWFM1SuiMKTc5yvlg+zKOHRfS8eIzX23gd/Y0xTZ1Oxmwf5quHxfZ5HsWLKF7P9Zi6kfkIMx2yWushSKvducY33IN85w5i1Kfomw0YSplfDH++mMXfuaTpzJICB/Qqkt4+5/H6XXffFFJzXtIatcfousfaRQEcneJCI+WJDBjXy2LfMG69eJxvJjVGwpsKu7HZbGf+iSiUw3ibjx/2tQkmsQ2jnpjInY18P1ai0X0vntSC/0MTJcfPLtlmNPDEXtilY9aWuoAanthusdOwfMTNVsmE4N3NVoX0MKRZ3FJ1jTevadVp6uVvlwg2ltBKYuWt7h2xBnPNgyV0N2+/dz9lnf6LntCPLd50u/orWnzbe8ZGyGgWP9b83mWdB1N6IE2hdrYXwHQpmpiC13pCqnTj3YszuHEF1a03il7/A9JpHvY9FAAA", "string": ""}, "headers": {"Server": "GitHub.com", "Date": "Wed, 18 Apr 2018 03:15:18 GMT", "Content-Type": "application/json; charset=utf-8", "Transfer-Encoding": "chunked", "Status": "200 OK", "X-RateLimit-Limit": "60", "X-RateLimit-Remaining": "57", "X-RateLimit-Reset": "1524023995", "Cache-Control": "public, max-age=60, s-maxage=60", "Vary": "Accept", "ETag": "W/\"5e2139d6dc651ed3364fa022f649ed26\"", "Last-Modified": "Wed, 18 Apr 2018 03:13:50 GMT", "X-GitHub-Media-Type": "github.v3; param=full; format=json", "Access-Control-Expose-Headers": "ETag, Link, Retry-After, X-GitHub-OTP, X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset, X-OAuth-Scopes, X-Accepted-OAuth-Scopes, X-Poll-Interval", "Access-Control-Allow-Origin": "*", "Strict-Transport-Security": "max-age=31536000; includeSubdomains; preload", "X-Frame-Options": "deny", "X-Content-Type-Options": "nosniff", "X-XSS-Protection": "1; mode=block", "Referrer-Policy": "origin-when-cross-origin, strict-origin-when-cross-origin", "Content-Security-Policy": "default-src 'none'", "X-Runtime-rack": "0.046946", "Content-Encoding": "gzip", "X-GitHub-Request-Id": "9B10:08B8:ACC8BA:15FD47C:5AD6B846"}, "status": {"code": 200, "message": "OK"}, "url": "https://api.github.com/repos/sigmavirus24/github3.py"}, "recorded_at": "2018-04-18T03:15:18"}, {"request": {"body": {"encoding": "utf-8", "string": ""}, "headers": {"User-Agent": "github3.py/1.1.0", "Accept-Encoding": "gzip, deflate", "Accept": "application/vnd.github.v3.full+json", "Connection": "keep-alive", "Accept-Charset": "utf-8", "Content-Type": "application/json"}, "method": "GET", "uri": "https://api.github.com/repos/sigmavirus24/github3.py/contents/README.rst"}, "response": {"body": {"encoding": "utf-8", "base64_string": "H4sIAAAAAAAAA7VXa2/qSBL9L/m6o4sfOBtfabSKHTAGQwY7+CWkkV+xDe2HYvMwo/nve8pAQrJzpb2z2g+WwHRXV50651Tzx10ZFMnd9ztz9Pg0H317a9q7X+7qoM2+vmuyAK+iV/FBGEpiHEm8dC9JnCCKvMCLYSLGXPzP8PVBkISIFxGkyU8IzMuS8Mvd7o1hc9a2dfN9MAjq/Fuat9ku/BZVxeAtqatm0ORpEezzt10jDAfnX8VvdTeIqrJNyrYZfGT4r7fk9dc42SesqnFQ1hbs988n3ET/UdyQVeHgEuQmNuJh85dwP5Uwtg8oeDP4CbDi6lCyKoi/HPwWHC5I7Zrk7QJFD9qPyvrLitquph6/5ixBfZcweGHkwzRw+MwXVvfPaZXq6mMaTEwumszvjU7uPDfa+QLjgomdG8ViH1ryKXDi1nP9el1GpX2ab5b764p5Jx0SS976rs9CTT4YAms9J2ZRJ5fB07zFuzLEmrCIZutSLeI61jLe28x30WSbBu489SxlEwr8ISrsynekU4BIhqpknmjWcWE3iaX00dclxfedZeo50lbX7GE8mWahON0GjpRFBaOVp1gb56G2StUyRiXKwXf11HOn+3UZ066JWfmWMglcU48dPV3aylRXM2HebXdqWr/4ziq1RuzFHsmWY0ldJC5Tv5C7dalr411iPeZeOWWe09aoJ9e1RYVcSt+d0+5pWC44zzk2nmvWoTCcGRbX0rMur5/UtCLMZ4S5ri7TSGMHXWO7SDSzUDukhkU4rNJbdNdlsqxmpmajdmmLZxM49knNz7GvkQ2sMSyl890x77sLLuIf6DuPjhWM8x3+EGpjzrcfZmo+3Olj+WPlqbrtfwlsKmCz8wSZMhdaFhYSQ9c632Fckt/sPFQ7I1deY3eKrtptpB2zWFvd61rGxRPltC6f84d3pnzl0pVJX3bP1C04V5rAPHCmfAx0/EPV43jzzFSmNL4zPqGbyGt87Wy65ORnezydrssls1fWSpp444fU1+RN7PAsLJfo1Dnr68rruudcqeKJeYhOFdhiCBem5hLYye0jgZWhMxYCd8pHJ517//3M5L1XHPdeftbBmakGt/jthZmWtZra9og9m13PJ2RuMvSbGDR7LaV/9A844TgyD0Zl2J0rXewMU8I70OxO15T/ZAp47Wu2YLhTFrl2DfW04AaHfncSl0zM1FMVLuyU+srKM/cfZ+BzAyWJUA1YPWXEb6DIEWsIc3ord/pkUYeuQppKPY3PAmGVosenWOWhRuXkaY87fcQ4sPeEtbwvxFAo6mK+qkihCA5rD1ChWZHGA1QDnRN6XOyMG6h3Fxesg+77nuhjs1pDRwumaxIjjcfY7UEJyIc0jYxtaN7fR7kCTC65TOb9OjBph44BQzA+911oyRkPXbAGeO7hIR05ktspOap5pujLYsx5QgbHQi/SCjzXNX7vCe0rEJH0EV/j18x3DqlZyPuoQNfOqnmP/rNsmUJBY3hoOiP/dYWPvEglZ+aRWsLC3nq32V34BzVufUvehKLPomJc+hb0jUjr0hUo8+ZddX0UR94E4BspA8plxH/wog47mYW5TA4FDi7Bc/jWPHAW6MKC3XgKVMjvfY0V8JqtPpq+mKrSXNcB2fezj0DK3kWYJVfV/zeaJ38D1zBhLvMDni3nhmAycvxQfNy/jNiTuZJeTPI+N8uIi/DZz54KLS0YcZcY0dfIQ+vgM3Wz99GPne+6p3Vg6l+73sno/d0k3W1DYXEyCrY3UKEhkLcR/2VMwbAwWaJKVazxjQ78cVZ7c9YPNW6BzZhExGeo85z1Z18Hx6EKLoWej7HD0EFSiIm8zGGsKtCYUUQ7miHPmwqspDmiYOK2DPomXzmho0oMDw9F/R0tmk4eNLguV5g08GmwUYZ+F8gc38FGTMH3KX9x5hq7nkJBwkxbcPpIPlDmDN780YVbV4avtvrIh3oPqQ8UqS/wHx7cgEozZA4fu04X1KNI5MzAgvwGDkCzc/H20vPbBweiSydp7ipHmt9A/3x+SnUnvV/yGX6tcDch9qaW413em3UkHGtyLap4XULbv5ET+PDpGK4ILOuoU+jWUfjuFDiT52QZ3vfuFaHncLIMXkw3D2dcU8fC7hGz+3MVSw0aQL0hnDBW+2lBPuRTFOyT+rtDEwnwM0Heod5NrD5WcL8MLojOsWZ2YbDn2uAEsRfZF/Ym1o60e0KTKO1rhtOfZ4cgnQzx7Lr9LKHv6GJ4YUvv4FAv7Wb72FLEwF1UYMiebhuecOR9KIZqxFzj6MaFM8Hv0YdKPiv05XJHeKr2OLfv1NmJ+k71dwVDPN88Akfe4fYHfcN1S+D6+a64rH5dl7iQJmVUxXmZ4kYaBk1yP8S731lebpu773/cNQl7/f/9ecBt/e8G/1sXffqzcnPg//BH5c8//w0bh7vYvQ0AAA==", "string": ""}, "headers": {"Server": "GitHub.com", "Date": "Wed, 18 Apr 2018 03:15:18 GMT", "Content-Type": "application/json; charset=utf-8", "Transfer-Encoding": "chunked", "Status": "200 OK", "X-RateLimit-Limit": "60", "X-RateLimit-Remaining": "56", "X-RateLimit-Reset": "1524023995", "Cache-Control": "public, max-age=60, s-maxage=60", "Vary": "Accept", "ETag": "W/\"cf382453dc51565502331213be3d0d7bf8252c13\"", "Last-Modified": "Wed, 18 Apr 2018 03:13:44 GMT", "X-GitHub-Media-Type": "github.v3; param=full; format=json", "Access-Control-Expose-Headers": "ETag, Link, Retry-After, X-GitHub-OTP, X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset, X-OAuth-Scopes, X-Accepted-OAuth-Scopes, X-Poll-Interval", "Access-Control-Allow-Origin": "*", "Strict-Transport-Security": "max-age=31536000; includeSubdomains; preload", "X-Frame-Options": "deny", "X-Content-Type-Options": "nosniff", "X-XSS-Protection": "1; mode=block", "Referrer-Policy": "origin-when-cross-origin, strict-origin-when-cross-origin", "Content-Security-Policy": "default-src 'none'", "X-Runtime-rack": "0.049911", "Content-Encoding": "gzip", "X-GitHub-Request-Id": "9B10:08B8:ACC8C1:15FD48A:5AD6B846"}, "status": {"code": 200, "message": "OK"}, "url": "https://api.github.com/repos/sigmavirus24/github3.py/contents/README.rst"}, "recorded_at": "2018-04-18T03:15:18"}], "recorded_with": "betamax/0.8.0"}

‎tests/integration/test_repos_repo.py‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -574,6 +574,14 @@ def test_directory_contents(self):
574574
assert content.name == filename
575575
assert isinstance(content, github3.repos.contents.Contents)
576576

577+
def test_directory_contents_for_a_file(self):
578+
"""Verify we raise a sensical exception for a directory's contents."""
579+
cassette_name = self.cassette_name('not_really_directory_contents')
580+
with self.recorder.use_cassette(cassette_name):
581+
repository = self.gh.repository('sigmavirus24', 'github3.py')
582+
with pytest.raises(github3.exceptions.UnprocessableResponseBody):
583+
repository.directory_contents('README.rst')
584+
577585
def test_edit(self):
578586
"""Test the ability to edit a repository."""
579587
self.token_login()

0 commit comments

Comments
 (0)