test(test_config.py): add tests for circular transclusion failure case #2252
Conversation
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
Circular transclusions lead to: ```bash E RecursionError: maximum recursion depth exceeded while calling a Python object /home/gitpod/.local/share/uv/python/cpython-3.9.23-linux-x86_64-gnu/lib/python3.9/pathlib.py:646: RecursionError ``` It might be nice to catch as soon as it happens, and provides a more comprehensive error message including the names of the files that collide. The tests are skipped to not intefer with normal condition testing, and commented with a TODO with a line to the one right before this one. > NOTE: The test with `demo_transclude_circular_bis` will fail because of the circular recursion. > The test with `demo_transclude_circular` will: > - currently fail with a `yaml.composer.ComposerError: expected a single document in the stream` > - if `https://github.com/copier-org/copier/pull/2251` is accepted, also fail because of the circular recursion. > But it might be a better test as it needs to go to the deepest transclusion to get the `_excludes`.
sisp
reviewed
Jul 31, 2025
Member
sisp
left a comment
sisp
left a comment
There was a problem hiding this comment.
Thanks for catching this bad error management and providing test cases, @RR5555! 🙇
We might even be able to add cycle detection with just some minor change. The YAML loader with support for the !include constructor is built inside the load_template_config() function. As the !include handler is a closure in this function, we could record the included YAML files in a set created in this function,, and when including another YAML file which has been included before, we could raise a proper error like CircularConfigFileIncludeError (declared in copier/errors.py). WDYT?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Issue
Circular transclusions lead to:
E RecursionError: maximum recursion depth exceeded while calling a Python object /home/gitpod/.local/share/uv/python/cpython-3.9.23-linux-x86_64-gnu/lib/python3.9/pathlib.py:646: RecursionErrorIt might be nice to catch it as soon as it happens, and provide a more comprehensive error message including the names of the files that collide.
This PR
This PR introduces tests for circular transclusions that shows that these are not really dealt with in a user-friendly manner in addition to taking some unnecessary time.
The tests are currently skipped to not interfere with normal condition testing, and commented with a TODO line similar to the last one in the previous section Issue.