Skip invalid containers with a warning #179
Open
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
…ng, loader, inventory, etc.
BigRoy
added
type: enhancement
iLLiCiTiT
reviewed
Nov 14, 2024
Comment on lines
+355
to
+356
| required = ["id", "name", "namespace", "loader", "representation"] | ||
| missing = [key for key in required if key not in data] |
There was a problem hiding this comment.
Suggested change
| required = ["id", "name", "namespace", "loader", "representation"] | |
| missing = [key for key in required if key not in data] | |
| required = {"id", "name", "namespace", "loader", "representation"} | |
| missing = required - set(data.keys()) |
iLLiCiTiT
reviewed
Nov 14, 2024
| if missing: | ||
| log.warning("Container '%s' is missing required keys: %s", | ||
| container, missing) | ||
| return {} |
There was a problem hiding this comment.
Shoulnd't this return None rather than empty dictionary?
There was a problem hiding this comment.
Not according to the functions type hint :D
Checked the usage of the function and noticed this may also influence setdress in maya - so I may want to do this differently.
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.
Changelog Description
Skip invalid containers with a warning - instead of breaking publishi…ng, loader, inventory, etc.
Additional review information
This avoids similar issues as #178 does - but is a 'fix' that would avoid the issue being problematic in existing scenes (instead of just on containerise) or if the container breaks in any other way.
The most likely case for these containers to become invalid was the issue #178 solves by 'bundling' undo so that users can't undo "half of the container creation" deleting only a few of its attributes. However, users can still break things in magical ways, time has shown us.
It would now log e.g. this if the container is incomplete and incomplete containers are not listed in the scene inventory either, because well they are incomplete:
Testing notes:
loader,representation, etc.A warning should be logged if any of the required keys ends up missing. The required keys are considered to be
["id", "name", "namespace", "loader", "representation"]