Implement api/timeline #80
Open
Conversation
This file contains hidden or 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
kraktus
reviewed
Oct 19, 2024
Comment on lines
+100
to
+102
| class TimelineEvents(TypedDict): | ||
| entries: list[dict[str, Any]] | ||
| users: dict[str, Any] |
There was a problem hiding this comment.
Good day, the idea is not to have any Any in the response type.
There was a problem hiding this comment.
Something like this?
class TimelineEvent(TypedDict):
type: str
data: dict[str, str | bool]
date: int
class TimelineUser(TypedDict):
id: str
name: str
title: str
patron: NotRequired[bool]
lass TimelineEvents(TypedDict):
entries: list[TimelineEvent]
users: dict[str, TimelineUser]
Defining all the different event-data dicts seems quite unproductive
This is not tested, just trying to get this PR implemented faster...
Comment on lines
+70
to
+71
| :param int since: timestamp to show events since, default 1356998400070 | ||
| :param int nb: max number of events to fetch, default 15 |
There was a problem hiding this comment.
Suggested change
| :param int since: timestamp to show events since, default 1356998400070 | |
| :param int nb: max number of events to fetch, default 15 | |
| :param since: only show events after this timestamp, default 1356998400070 (the earliest allowed by Lichess) | |
| :param nb: max number of events to fetch, default 15 |
We generally leave out the types here since they are already given via the type hints.
5 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
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.
Implements
/api/timelineendpoint documented here.Checklist when adding a new endpoint
README.mdclient.users.get_user(), Correct:client.users.get()berserk/types/, exampleCHANGELOG.mdin theTo be releasedsection (to be created if necessary)