Allow users to handle invalid nodes coming from a search against the API #431
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
|
Merging to
|
InnocentBug
commented
Feb 27, 2024
| except IndexError: # This is not a random access iteration. | ||
| # So if fetching a next page wasn't enough to get the index inbound, | ||
| # The iteration stops | ||
| raise StopIteration | ||
|
|
||
| if self.auto_load_nodes: |
There was a problem hiding this comment.
This is the ❤️ of this PR.
InnocentBug
commented
Feb 27, 2024
| while True: | ||
| try: | ||
| try: | ||
| material_node = next(materials_paginator) |
There was a problem hiding this comment.
This is using the change in a test.
InnocentBug
commented
Feb 27, 2024
| @@ -97,6 +97,55 @@ the code is written to get a better grasp of it? | |||
| There you will find documentation on everything from how our code is structure, | |||
| how we aim to write our documentation, CI/CD, and more._ | |||
|
|
|||
| --- | |||
|
|
|||
| **Q:** What can I do, when my `api.search(...)` fails with a `cript.nodes.exception.CRIPTJsonDeserializationError` or similar? | |||
There was a problem hiding this comment.
FAQ to explain to users of how to recover from bad search results.
(Hopefully rarely needed.)
But good to have for debugging anyways.
duboyal
approved these changes
Feb 28, 2024
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.
Description
Before there was no path to recovery if an API search was returning nodes that were deemed incorrect by the SDK.
Now, there is a way to disable auto node conversion.
I think this should only be last resort to recover for advanced users.
But I included an FAQ to explain it to users.
Changes
Known Issues
Notes
Checklist
CONTRIBUTORS.md) in the pull request source branch.