Fix parent property of PathTemplate in case of optional key #1013
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.
Context
The parent property of PathTemplate doesn't create a correct PathTemplate when optional keys are used. For example, if you create a template
shots/{Sequence}[-{seq_num}]/{Shot}/{Step}/work
, the parent property will return a templatePath without the optional[-{seq_num}]
part.Problem
When creating a PathTemplate with optional keys, the parent property omits these keys in the generated path. This can result in incorrect or incomplete paths.
Solution
To solve this issue, instead of passing self.definition to the PathTemplate constructor, we use self._repr_def, which contains the optional keys.
Testing
A test has been added to verify that the parent property now correctly includes optional keys in the generated PathTemplate.