Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

GetWithRelationship(s) conveniences #1308

Conversation

elliotcmorris
Copy link
Contributor

@elliotcmorris elliotcmorris commented May 13, 2024

Description

Closes #973

Adds standard set of singular/batch conveniences for getWithRelationship(s), for both exceptional and variant error modalities.

Due to the inability to use the test framework for conveniences, it's all a bit rough & ready. I'm hoping just a happy path and a failure case are enough considering the scope of duplication involved.

Reviewer Notes

Docs are in another commit. Just sort of worked out this way but I thought it's probably a better reviewer experience so left it like that. Will squash after.

Good luck trying to keep all the variations strait in your head when looking at docs & bindings ... I really struggled.

Copy link
Member

@feltech feltech left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good work keeping the tests as succinct as you have!

Methinks a prevalence of copy-paste errors abound 😉

@elliotcmorris
Copy link
Contributor Author

Methinks a prevalence of copy-paste errors abound 😉

Yeah no doubt. I spent forever splatting them but was absolutely sure there were gonna be more. In fact, I sort of think I may have made it worse in some of my attempts to be consistent.

Should likely have split GetWithRelationship() and GetWithRelationships() up into different commits and worked on them separately, the reason I didn't was cause of the GIL tests, didn't want failing tests, but also didnt want to comment out the check to remind me to implement the other formulation. This is a silly reason and easily worked around.

Copy link
Member

@feltech feltech left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sooo close

Conveniences for exceptional and variant based error-object modes
for the GetWithRelationship(s) methods, for both singular and
batch variations.

Signed-off-by: Elliot Morris <[email protected]>
@elliotcmorris elliotcmorris force-pushed the work/973-conveniences-relationships branch from 7f29e50 to 74685f0 Compare May 24, 2024 10:11
@elliotcmorris elliotcmorris merged commit 0869aba into OpenAssetIO:main May 28, 2024
44 checks passed
@elliotcmorris elliotcmorris deleted the work/973-conveniences-relationships branch May 28, 2024 09:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Conveniences for getWithRelationship[s]
2 participants