Add type annotations for Spotify JSON objects #695
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
| "expires_in": int, | ||
| "refresh_token": str, | ||
| "expires_at": int | ||
| }) |
There was a problem hiding this comment.
scope and refresh_token will not be present for the client credentials flow, and so they should be optional.
There was a problem hiding this comment.
In the future we could look into creating a new type if possible, but probably not a worry now
There was a problem hiding this comment.
I discussed this here. We can either:
- Ignore the fact that they will not be present
- Create a class
TokenInfo - Remove this, use
Dict[str, Any], and wait untilTypeDictsupports optional keys (or just forget it)
spotipy/json_types.py
Outdated
| "total": int, | ||
| }) | ||
|
|
||
| PrivateUser = TypedDict("PrivateUser", { |
There was a problem hiding this comment.
The email, explicit_content, product, and country properties of the PrivateUser object can still be nil if certain scopes are missing, and so these should also be optional. See here.
There was a problem hiding this comment.
There is the same issue that I described here.
akathorn
changed the title
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Working on #439. It is WIP but I would like some feedback before I validate the return types one by one.
All public methods are annotated. I haven't added anything that alters the runtime behavior in any way.
The arguments are straightforward since they are all basic types, but I had to define new types for the return values. The alternative is using
Dict[str, Any]for all the JSON dicts, which would be more "lightweight" but provides near-zero typing information.It works on nearly examples!