Add helper function to use paging links#9306
Closed
Hugo-Inmanta wants to merge 39 commits intomasterfrom
Closed
Conversation
Hugo-Inmanta
commented
Jul 2, 2025
wouterdb
reviewed
Jul 2, 2025
src/inmanta/util/__init__.py
Outdated
|
|
||
| async def iter_result(result: "Result", env: str, client: "Client") -> AsyncIterator["Result"]: | ||
| yield result | ||
| async for next_link_url in result.all(): |
Contributor
There was a problem hiding this comment.
this plumbing is a bit weird, we should do a call about it I think
wouterdb
reviewed
Jul 3, 2025
tests/util/test_util.py
Outdated
Comment on lines
+584
to
+590
| async def test_helper_method_using_paging_links( | ||
| client: protocol.Client, | ||
| fetch_all_data_coro: Coroutine[Any, Any, common.Result], | ||
| fetch_page_by_page_coro: Coroutine[Any, Any, common.Result], | ||
| page_size: int, | ||
| env: str, | ||
| ) -> None: |
Contributor
There was a problem hiding this comment.
This helper makes it hard to understand what the testcase is testing.
Options I see to improve:
- I would pass in the expected number of pages as a parameter to this method
- I would name it
assert_nottest_(i.e. it is not a test, it is an assertion helper)
Hugo-Inmanta
commented
Jul 7, 2025
wouterdb
requested changes
Jul 8, 2025
wouterdb
reviewed
Jul 9, 2025
| description: Add helper method to use paging links | ||
| issue-nr: 8801 | ||
| change-type: minor | ||
| destination-branches: [master, iso8] |
Contributor
There was a problem hiding this comment.
I would also include a changelog entry
wouterdb
approved these changes
Jul 9, 2025
changelogs/unreleased/8801-add-helper-method-to-use-paging-links.yml
Outdated
Show resolved
Hide resolved
…ks.yml Co-authored-by: Wouter De Borger <wouter.deborger@inmanta.com>
Co-authored-by: Wouter De Borger <wouter.deborger@inmanta.com>
Contributor
|
Processing this pull request |
Contributor
|
Failed to merge changes into iso8 due to merge conflict. Please open a pull request for these branches separately by cherry-picking the commit that was made on the branch master (git cherry-pick d6c7c13). |
Contributor
|
Merged into branches master in d6c7c13 |
Contributor
|
Not closing this pull request due to previously commented issues for some of the destination branches. Please open a separate pull request for those branches by cherry-picking the relevant commit. You can safely close this pull request and delete the source branch. |
inmantaci
pushed a commit
that referenced
this pull request
Jul 10, 2025
…urned by v2 Rest API endpoints that support paging. See [documentation](helper_method_for_paging) for more information. (Issue #8801, PR #9306) # Description Add `Result.all()` helper method. closes #8801 Follow-up ticket for api improvement [here](#9320), I tried for a while to get the plumbing right, but I couldn't. # Self Check: Strike through any lines that are not applicable (`~~line~~`) then check the box - [ ] Attached issue to pull request - [ ] Changelog entry - [ ] Type annotations are present - [ ] Code is clear and sufficiently documented - [ ] No (preventable) type errors (check using make mypy or make mypy-diff) - [ ] Sufficient test cases (reproduces the bug/tests the requested feature) - [ ] Correct, in line with design - [ ] End user documentation is included or an issue is created for end-user documentation (add ref to issue here: ) - [ ] If this PR fixes a race condition in the test suite, also push the fix to the relevant stable branche(s) (see [test-fixes](https://internal.inmanta.com/development/core/tasks/build-master.html#test-fixes) for more info)
Contributor
|
This branch was not deleted as it seems to still be in use. |
Hugo-Inmanta
added a commit
that referenced
this pull request
Jul 10, 2025
…urned by v2 Rest API endpoints that support paging. See [documentation](helper_method_for_paging) for more information. (Issue #8801, PR #9306) Add `Result.all()` helper method. closes #8801 Follow-up ticket for api improvement [here](#9320), I tried for a while to get the plumbing right, but I couldn't. Strike through any lines that are not applicable (`~~line~~`) then check the box - [ ] Attached issue to pull request - [ ] Changelog entry - [ ] Type annotations are present - [ ] Code is clear and sufficiently documented - [ ] No (preventable) type errors (check using make mypy or make mypy-diff) - [ ] Sufficient test cases (reproduces the bug/tests the requested feature) - [ ] Correct, in line with design - [ ] End user documentation is included or an issue is created for end-user documentation (add ref to issue here: ) - [ ] If this PR fixes a race condition in the test suite, also push the fix to the relevant stable branche(s) (see [test-fixes](https://internal.inmanta.com/development/core/tasks/build-master.html#test-fixes) for more info)
18 tasks
inmantaci
pushed a commit
that referenced
this pull request
Jul 10, 2025
…urned by v2 Rest API endpoints that support paging. See [documentation](helper_method_for_paging) for more information. (Issue #8801, PR #9337) follow up iso8 PR to #9306 Add `Result.all()` helper method. closes #8801 Follow-up ticket for api improvement [here](#9320), I tried for a while to get the plumbing right, but I couldn't. Strike through any lines that are not applicable (`~~line~~`) then check the box - [ ] Attached issue to pull request - [ ] Changelog entry - [ ] Type annotations are present - [ ] Code is clear and sufficiently documented - [ ] No (preventable) type errors (check using make mypy or make mypy-diff) - [ ] Sufficient test cases (reproduces the bug/tests the requested feature) - [ ] Correct, in line with design - [ ] End user documentation is included or an issue is created for end-user documentation (add ref to issue here: ) - [ ] If this PR fixes a race condition in the test suite, also push the fix to the relevant stable branche(s) (see [test-fixes](https://internal.inmanta.com/development/core/tasks/build-master.html#test-fixes) for more info) # Description * Short description here * closes *Add ticket reference here* # Self Check: Strike through any lines that are not applicable (`~~line~~`) then check the box - [ ] Attached issue to pull request - [ ] Changelog entry - [ ] Type annotations are present - [ ] Code is clear and sufficiently documented - [ ] No (preventable) type errors (check using make mypy or make mypy-diff) - [ ] Sufficient test cases (reproduces the bug/tests the requested feature) - [ ] Correct, in line with design - [ ] End user documentation is included or an issue is created for end-user documentation (add ref to issue here: ) - [ ] If this PR fixes a race condition in the test suite, also push the fix to the relevant stable branche(s) (see [test-fixes](https://internal.inmanta.com/development/core/tasks/build-master.html#test-fixes) for more info)
inmantaci
pushed a commit
that referenced
this pull request
Jul 10, 2025
# Description follow up fix to github.com//pull/9306 # Self Check: Strike through any lines that are not applicable (`~~line~~`) then check the box - [ ] Attached issue to pull request - [ ] Changelog entry - [ ] Type annotations are present - [ ] Code is clear and sufficiently documented - [ ] No (preventable) type errors (check using make mypy or make mypy-diff) - [ ] Sufficient test cases (reproduces the bug/tests the requested feature) - [ ] Correct, in line with design - [ ] End user documentation is included or an issue is created for end-user documentation (add ref to issue here: ) - [ ] If this PR fixes a race condition in the test suite, also push the fix to the relevant stable branche(s) (see [test-fixes](https://internal.inmanta.com/development/core/tasks/build-master.html#test-fixes) for more info)
inmantaci
pushed a commit
that referenced
this pull request
Jul 10, 2025
# Description follow up fix to github.com//pull/9306 # Self Check: Strike through any lines that are not applicable (`~~line~~`) then check the box - [ ] Attached issue to pull request - [ ] Changelog entry - [ ] Type annotations are present - [ ] Code is clear and sufficiently documented - [ ] No (preventable) type errors (check using make mypy or make mypy-diff) - [ ] Sufficient test cases (reproduces the bug/tests the requested feature) - [ ] Correct, in line with design - [ ] End user documentation is included or an issue is created for end-user documentation (add ref to issue here: ) - [ ] If this PR fixes a race condition in the test suite, also push the fix to the relevant stable branche(s) (see [test-fixes](https://internal.inmanta.com/development/core/tasks/build-master.html#test-fixes) for more info)
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
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.
Description
Add
Result.all()helper method.closes #8801
Follow-up ticket for api improvement here, I tried for a while to get the plumbing right, but I couldn't.
Self Check:
Strike through any lines that are not applicable (
~~line~~) then check the box