RESTClient: paginators follow-up - Githubissues

dlt-hub / dlt

data load tool (dlt) is an open source Python library that makes data loading easy 🛠️

https://dlthub.com/docs

Apache License 2.0

2.04k stars 123 forks source link

RESTClient: paginators follow-up #1552

Open willi-mueller opened 1 week ago

willi-mueller commented 1 week ago

Feature description

Documentation:

[ ] Document SinglePagePaginator
[ ] Write why it is helpful to declare different types during type checking compared to code execution time. To me, this decision is not obvious.

Tests:

[ ] test_paginators.py: assert that the initial state of the paginator is as intended before we call update_state(). Otherwise, tests could be green if update_state() has no effect.
[ ] Consider adding a test case that the first request is without the pagination parameter and only starting from the second page do we find a page=2 in the request params

Paginator implementation

[ ] change signature of update_request(self, request: Request) -> None to 1update_request(self, request: Request) -> Request`

Related issues

https://github.com/dlt-hub/dlt/issues/1325 Follow-up to https://github.com/dlt-hub/dlt/pull/1509

rudolfix commented 1 week ago

please also convert class-based tests into our regular test module. this is how we structure our tests