docs(datasets): document asymmetric NotFoundError vs None behavior for get_dataset#495
Draft
thiagobomfin-galileo wants to merge 1 commit intomainfrom
Draft
docs(datasets): document asymmetric NotFoundError vs None behavior for get_dataset#495thiagobomfin-galileo wants to merge 1 commit intomainfrom
thiagobomfin-galileo wants to merge 1 commit intomainfrom
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #495 +/- ##
==========================================
+ Coverage 82.00% 82.06% +0.05%
==========================================
Files 96 96
Lines 9260 9260
==========================================
+ Hits 7594 7599 +5
+ Misses 1666 1661 -5 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
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
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.
User description
Shortcut:
get_dataset by ID throws NotFoundError but by name returns None
Description:
across both the classic and future SDK APIs:
HTTP 404 when not found — causing a NotFoundError to be raised before the SDK can intercept
it
when not found — causing the SDK to return None instead of raising
Notes
This is a documentation-only change. The behavior itself is not modified — this PR makes
the asymmetry explicit so callers know what to expect and can handle both cases correctly:
Tests:
Generated description
Below is a concise technical summary of the changes proposed in this PR:
Clarify dataset lookup behavior in
Datasets.getby documenting that ID queries raiseNotFoundErrorwhile name queries returnNone, so callers know what to expect. Describe the same asymmetry in the futureDataset.getmethod so future-API consumers can decide whether to catch the exception or handle a None return value.Latest Contributors(2)