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

feat: add dynamic file structures in loop using yield-tag #1855

Open
wants to merge 3 commits into
base: master
Choose a base branch
from

Conversation

kj-9
Copy link

@kj-9 kj-9 commented Nov 10, 2024

What I did:

  • Added a new Jinja extension in copier/jinja_ext.py to handle yield tags
    • This is a lightweight extension that detects yield tags and sets up the necessary context through jinja_env
  • Updated _render_path to return multiple destination paths and their corresponding contexts when yield tags are present
    • Internally, delegated the recursive logic for generating paths and contexts from yield tags to the _render_parts function
  • Added extra_context parameter to _render_file to enable injection of contexts generated from yield tags

… extention for yield tag, allow _render_path to generate mulitple paths and contexts when yield tag is used
… test file to test dynamic file structure feature
@kj-9
Copy link
Author

kj-9 commented Nov 10, 2024

hopefully closes #1271

Copy link

codecov bot commented Nov 10, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 97.91%. Comparing base (8391966) to head (bc99b0d).
Report is 9 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #1855      +/-   ##
==========================================
+ Coverage   97.67%   97.91%   +0.23%     
==========================================
  Files          49       51       +2     
  Lines        5238     5359     +121     
==========================================
+ Hits         5116     5247     +131     
+ Misses        122      112      -10     
Flag Coverage Δ
unittests 97.91% <100.00%> (+0.23%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.


🚨 Try these New Features:

@sisp sisp self-requested a review November 12, 2024 20:56
@yajo
Copy link
Member

yajo commented Nov 20, 2024

I only reviewed tests in depth so far, and it seems the interface is almost exactly what I meant! Awesome!

Quoting from #1271 (comment):

are you rendering a filename?
No: just let the exception raise and print a nice message "Using yield outside of file names isn't supported".

That seems to be the only missing part. At least I saw no test for that. Could you add this please?

When done I'll review the implementation. This PR is big!

Thank you very much 😊

…d YieldTagInFileError and raise it if yield tag used when rendering file content. also add the test case
@kj-9
Copy link
Author

kj-9 commented Nov 22, 2024

@yajo

Thank you for your review!

I've added a new commit that implements the behavior you mentioned - throwing an exception when yield is used for rendering file contents. I've also added the corresponding test case.

Looking forward to your implementation review!

Comment on lines +117 to +118

pass
Copy link
Contributor

Choose a reason for hiding this comment

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

pass is unnecessary if there's a docstring 🙂

Suggested change
pass

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.

3 participants