Skip to content
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

Reading custom endpoint results SDK support #132

Merged
merged 10 commits into from
Jun 20, 2024
Merged

Reading custom endpoint results SDK support #132

Changes from 1 commit
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
4fc844b
reading custom endpoint results works locally.
philippWassibauer Jun 16, 2024
3e55683
Update dune_client/api/custom.py
Jun 17, 2024
a812f5b
add docstrings
philippWassibauer Jun 17, 2024
13fcc1b
Merge branch 'add-custom-endpoints' of github.com:duneanalytics/dune-…
philippWassibauer Jun 17, 2024
9aa2f86
fix to get pylint to play
philippWassibauer Jun 17, 2024
92254e1
add basic integration testing for custom endpoints
philippWassibauer Jun 19, 2024
fc3a52b
fix
philippWassibauer Jun 19, 2024
8b20bad
test naming fix
philippWassibauer Jun 19, 2024
bbfb862
fix pyling
philippWassibauer Jun 20, 2024
e41ff9c
linted
philippWassibauer Jun 20, 2024
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
2 changes: 1 addition & 1 deletion dune_client/api/custom.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
ResultsResponse,
)


# pylint: disable=duplicate-code
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is likely because of all the filter arguments and suggests a deeper change to the project. Introduce a ResultFilter structure that contains all the filtering possibilities:

@dataclass
class ResultFilter:
    limit: Optional[int] = None
    offset: Optional[int] = None
    columns: Optional[List[str]] = None
    sample_count: Optional[int] = None
    filters: Optional[str] = None
    sort_by: Optional[List[str]] = None

Then here would look more like:

    def get_custom_endpoint_result(
        self,
        handle: str,
        endpoint: str,
        filter: Optional[ResultFilter]
    ) -> ResultsResponse:

It would resolve both duplicated code lint warning and also reduce the "argument overload" lint error that is being globally suppressed here

dune-client/.pylintrc

Line 4 in ed3836d

max-args=10

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I will log this and do at another time.

class CustomEndpointAPI(BaseRouter):
"""
Custom endpoints API implementation.
Expand Down
Loading