Jinja2 Templating Infra #446
Merged
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
Functionality to render jinja2 templates to make creating batch files easier. Also opens up the door to future use of templates like creating config files. Associated docs+tests included.
TimothyWillard
added
enhancement
TimothyWillard
requested review from
pearsonca,
jcblemai,
fang19911030,
saraloo,
MacdonaldJoshuaCaleb and
emprzy
11 tasks
Attempt to fix Jinja2 lader issue by falling back to a file system loader if a package loader fails.
TimothyWillard
force-pushed
the
feature/365/templating-infra
branch
from
b5f3aad to
1d82cd4
Compare
emprzy
approved these changes
Jan 7, 2025
pearsonca
reviewed
Jan 7, 2025
Per @pearsonca request: * Only use the `PackageLoader` for setting up the jinja environment. * Removed `gempyor._jinja._get_template/_render_template`.
Isn't that what PRs are for? I don't see why code needs documentation to reflect the decisions made to produce it. |
saraloo
approved these changes
Jan 10, 2025
jcblemai
approved these changes
Jan 10, 2025
pearsonca
approved these changes
Jan 11, 2025
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.
Describe your changes.
This pull request extracts out the
Jinja2templating infrastructure from GH-394 to make that pull request a bit more simple to review. It adds an internal_jinjamodule to thegempyorpackage with the (closely related) functions:_get_templateto pull templates from thetemplates/directory,_render_templateto render a template with provided template data,_render_template_to_fileto render a template and save it to a file, and_render_template_to_temp_fileto render a template to a temp file and return that temp file.Changes include unit tests and docstrings to document internal functionality.
Does this pull request make any user interface changes? If so please describe.
The user interface changes are none. All changes provide internal utilities to the
gempyorpython package.Those are reflected in updates to the documentation in the docstrings of the relevant functions.
What does your pull request address? Tag relevant issues.
This pull request addresses GH-365 by simplifying GH-394.