BUG/MNT: return InvalidResult if container is malformed#362
Merged
tangkong merged 8 commits intopcdshub:masterfrom Jun 10, 2025
Merged
BUG/MNT: return InvalidResult if container is malformed#362tangkong merged 8 commits intopcdshub:masterfrom
tangkong merged 8 commits intopcdshub:masterfrom
Conversation
7 tasks
ZLLentz
reviewed
Jun 4, 2025
Co-authored-by: Zachary Lentz <ZLLentz@users.noreply.github.com>
ZLLentz
reviewed
Jun 4, 2025
Member
ZLLentz
left a comment
There was a problem hiding this comment.
This makes sense and I think is well-motivated.
I'm trying to be a little cautious because it is an API break on some level.
For users with well-formed databases it will behave the same at least.
ZLLentz
reviewed
Jun 4, 2025
ZLLentz
previously approved these changes
Jun 4, 2025
Member
ZLLentz
left a comment
There was a problem hiding this comment.
I'm on board. Not sure if you want to let this sit and percolate or not (it's an API break after all).
Co-authored-by: Zachary Lentz <ZLLentz@users.noreply.github.com>
Contributor
Author
|
I'll merge this as is (with extra docs context added). I'll go about making followup issues for the unresolved comments. |
This was referenced Jun 9, 2025
ZLLentz
approved these changes
Jun 10, 2025
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.
Description
Creates an InvalidResult that may be returned if a container is malformed. Exceptions are still raised if keys do not exist. This does change the behavior of a few methods, which used to simply skip results that couldn't be created.
This could be considered an API break.
Fixes a variety of type hinting errors along the way
Motivation and Context
#299
Also I wanted to test pcds-6.0.1 development
How Has This Been Tested?
Mostly through test suite
Where Has This Been Documented?
This PR
Pre-merge checklist
docs/pre-release-notes.shand created a pre-release documentation page