Refactor: DuneInterface.refresh return type #26
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
bh2smith
changed the title
gentrexha
reviewed
Oct 27, 2022
Comment on lines
+37
to
+42
| def __hash__(self) -> int: | ||
| """ | ||
| This contains the query ID and the values of relevant parameters. | ||
| Thus, it is unique for caching purposes | ||
| """ | ||
| return self.url().__hash__() |
There was a problem hiding this comment.
Unfortunately this did not work out as I had expected:
gentrexha
reviewed
Oct 27, 2022
| query_id: int | ||
| name: Optional[str] = "unnamed" |
There was a problem hiding this comment.
Also liked you've added the name. Going to be using this in the excel export!
There was a problem hiding this comment.
The name was always here, but this just makes it optional with a default value so that it's less annoying when you don't want to use it.
|
This is an interface breaking change so we will have to bump the version to 0.1.0 |
bh2smith
commented
Nov 2, 2022
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
In order for users to cache results, they need access to the JOB ID of their execution. The refresh method now returns more enriched data giving these advanced options to the user.
We lost the convenience of not having to check for an optional field, but introduced a similar convenience in the
ResultsResponse(i.e. the new methodget_rowswhich performs the necessary assertion check) and always returns a list of dune records.Bonus feature is the Query__hash__ implementation which will allow people to cache results of different executions of the same query with different parameters.
Closes #25 and closes #27