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

kj-9 · 2024-11-10T03:24:14Z

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 · 2024-11-10T03:25:01Z

hopefully closes #1271

codecov · 2024-11-10T08:30:05Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 97.74%. Comparing base (8391966) to head (6f4acec).
Report is 10 commits behind head on master.

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #1855      +/-   ##
==========================================
+ Coverage   97.67%   97.74%   +0.07%     
==========================================
  Files          49       51       +2     
  Lines        5238     5358     +120     
==========================================
+ Hits         5116     5237     +121     
+ Misses        122      121       -1

Flag	Coverage Δ
unittests	`97.74% <100.00%> (+0.07%)`	⬆️

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:

Flaky Tests Detection - Detect and resolve failed and flaky tests

yajo · 2024-11-20T06:08:42Z

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 · 2024-11-22T15:39:15Z

@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!

copier/errors.py

… is unnecessary if there's a docstring

yajo

Finally, the first code review is here!

Apart from what's mentioned, I also miss the documentation.

Thank you!

copier/jinja_ext.py

copier/main.py

…ntext with yield_name and yield_iterable attributes in YieldEnvironment and YieldExtension

…or check to _render_file method to enforce yield tag restrictions during file rendering

…r of parameters in _yield_support method for consistency and clarity

…ng over lists to generate files and directories

kj-9 · 2024-12-02T13:04:18Z

@yajo
Thank you for the quick review!

I have added a few commits:

Fixes according to your comments
Minor code refactoring

And in the last commit, I added documentation. Specifically, three points:

Added a row for the new feature in the comparison table (as far as I know, only copier supports this feature)
Added jinja_ext.py to the Reference
Added a section explaining the new feature to Configuring.

This is my first time adding documentation, so I'm not sure if it meets your expectations.
Could you please review it again?

yajo

Implementation looks very good, thanks!

Please review a couple of suggestions for the docs, so we can merge.

@copier-org/maintainers this is an important feature, would you like to add your reviews?

docs/configuring.md

sisp · 2024-12-30T11:05:57Z

I'll try to give feedback later today.

pawamoy

A few suggestions, nothing critical, looking good 🙂

copier/jinja_ext.py

copier/main.py

sisp

Thanks for working on this long-awaited feature, @kj-9! 🙏 I have a few conceptual remarks. WDYT, @kj-9 and @copier-org/maintainers?

copier/jinja_ext.py

…r for handling multiple yield tags, with some test cases

yajo

This mostly LGTM, just a couple of minor comments. Thanks!

yajo · 2025-01-07T12:30:35Z

copier/jinja_ext.py

+
+    !!! example
+
+        ```pycon


Suggested change

```pycon

```python

@yajo
see @pawamoy 's comment #1855 (comment)

in my dev env, syntax highlighting on console results are bit different based on pycon or python

if set pycon

if set python

I'm not sure which is suitable here.

yajo · 2025-01-07T12:32:32Z

copier/jinja_ext.py

+    environment: YieldEnvironment
+
+    def __init__(self, environment: YieldEnvironment):
+        super().__init__(environment)


Thought: It seems to me like this method override is doing nothing, right? Could you remove these lines?

@yajo
your right, done in 5f11c99

…ctor in YieldExtension class

kj-9 added 2 commits November 10, 2024 12:21

feat(add-dynamic-file-structures-in-loop-using-yield-tag): add jinja2…

4329653

… extention for yield tag, allow _render_path to generate mulitple paths and contexts when yield tag is used

test(add-test-for-dynamic-file-structures-using-yield-tag): add a new…

7164aa7

… test file to test dynamic file structure feature

kj-9 mentioned this pull request Nov 10, 2024

Generate file structures on dynamic loop #1271

Open

sisp self-requested a review November 12, 2024 20:56

fix(raise-error-if-yield-tag-is-used-when-rendering-file-content): ad…

bc99b0d

…d YieldTagInFileError and raise it if yield tag used when rendering file content. also add the test case

pawamoy reviewed Nov 22, 2024

View reviewed changes

copier/errors.py Outdated Show resolved Hide resolved

refactor(delete-unnecessary-statement-in-YieldTagInFileError): pass…

6f4acec

… is unnecessary if there's a docstring

yajo requested changes Nov 28, 2024

View reviewed changes

kj-9 added 4 commits December 1, 2024 13:10

refactor(apply-review-comments): Improve docstrings, replace yield_co…

3634d57

…ntext with yield_name and yield_iterable attributes in YieldEnvironment and YieldExtension

fix(raise-error-for-yield-tag-in-render-file): Move YieldTagInFileErr…

8e08aea

…or check to _render_file method to enforce yield tag restrictions during file rendering

refactor(reorder-parameters-in-yield-support-method): Change the orde…

1aac269

…r of parameters in _yield_support method for consistency and clarity

docs(add-docs-for-loops-using-yield-tag): Add documentation for loopi…

c6970f5

…ng over lists to generate files and directories

kj-9 requested a review from yajo December 3, 2024 06:19

yajo requested changes Dec 30, 2024

View reviewed changes

docs/configuring.md Outdated Show resolved Hide resolved

docs/configuring.md Outdated Show resolved Hide resolved

pawamoy reviewed Dec 30, 2024

View reviewed changes

sisp requested changes Dec 30, 2024

View reviewed changes

copier/jinja_ext.py Show resolved Hide resolved

copier/jinja_ext.py Show resolved Hide resolved

kj-9 added 5 commits January 3, 2025 19:43

Merge remote-tracking branch 'upstream/master' into HEAD

847c1c6

docs(docs-for-yield-tag): Revise documentation for the yield tag

ac042c5

style(apply-lint): apply pre-commit lint

b8033df

style(main.py): add comment and fix unesessary diffs

3851329

fix(add-treatment-for-multiple-yield-tags): add MultipleYieldTagsErro…

810f448

…r for handling multiple yield tags, with some test cases

yajo requested changes Jan 7, 2025

View reviewed changes

fix(remove-unnecessary-method-overriding): remove unnecessary constru…

5f11c99

…ctor in YieldExtension class

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

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

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

kj-9 commented Nov 10, 2024

kj-9 commented Nov 10, 2024

codecov bot commented Nov 10, 2024 •

edited

Loading

yajo commented Nov 20, 2024

kj-9 commented Nov 22, 2024

yajo left a comment

kj-9 commented Dec 2, 2024

yajo left a comment

sisp commented Dec 30, 2024

pawamoy left a comment

sisp left a comment

yajo left a comment

yajo Jan 7, 2025

kj-9 Jan 7, 2025

yajo Jan 7, 2025

kj-9 Jan 7, 2025

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

Are you sure you want to change the base?

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

Conversation

kj-9 commented Nov 10, 2024

kj-9 commented Nov 10, 2024

codecov bot commented Nov 10, 2024 • edited Loading

Codecov Report

yajo commented Nov 20, 2024

kj-9 commented Nov 22, 2024

yajo left a comment

Choose a reason for hiding this comment

kj-9 commented Dec 2, 2024

yajo left a comment

Choose a reason for hiding this comment

sisp commented Dec 30, 2024

pawamoy left a comment

Choose a reason for hiding this comment

sisp left a comment

Choose a reason for hiding this comment

yajo left a comment

Choose a reason for hiding this comment

yajo Jan 7, 2025

Choose a reason for hiding this comment

kj-9 Jan 7, 2025

Choose a reason for hiding this comment

yajo Jan 7, 2025

Choose a reason for hiding this comment

kj-9 Jan 7, 2025

Choose a reason for hiding this comment

codecov bot commented Nov 10, 2024 •

edited

Loading