Skip to content

Return empty array instead of raising NoResultsError for missing results #483

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Aug 3, 2023
Merged

Return empty array instead of raising NoResultsError for missing results #483

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b58b533
Return empty array instead of raising NoResultsError for missing results
justinpolygon Aug 3, 2023
c6f34cc
Remove NoResultsError import
justinpolygon Aug 3, 2023
ddcb9d6
Merge branch 'master' into jw-empty-array-results
justinpolygon Aug 3, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 0 additions & 7 deletions docs/source/Exceptions.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,10 +17,3 @@ BadResponse
:members:
:undoc-members:

==============================================================
NoResultsError
==============================================================
.. autoclass:: polygon.exceptions.NoResultsError
:members:
:undoc-members:

8 changes: 0 additions & 8 deletions polygon/exceptions.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,11 +12,3 @@ class BadResponse(Exception):
"""

pass


class NoResultsError(Exception):
"""
Missing results key
"""

pass
10 changes: 4 additions & 6 deletions polygon/rest/base.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
from ..logging import get_logger
import logging
from urllib.parse import urlencode
from ..exceptions import AuthError, BadResponse, NoResultsError
from ..exceptions import AuthError, BadResponse

logger = get_logger("RESTClient")
version = "unknown"
Expand Down Expand Up @@ -116,11 +116,7 @@ def _get(

if result_key:
if result_key not in obj:
raise NoResultsError(
f'Expected key "{result_key}" in response {obj}.'
+ "Make sure you have sufficient permissions and your request parameters are valid."
+ f"This is the url that returned no results: {resp.geturl()}"
)
return []
obj = obj[result_key]

if deserializer:
Expand Down Expand Up @@ -198,6 +194,8 @@ def _paginate_iter(
options=options,
)
decoded = self._decode(resp)
if result_key not in decoded:
return []
for t in decoded[result_key]:
yield deserializer(t)
if "next_url" in decoded:
Expand Down