feat: ✨Add jinja settings support for golden config plugin #527
Conversation
cablesquirrel
requested review from
itdependsnetworks,
jeffkala and
nkallergis
as code owners
cablesquirrel
changed the title
itdependsnetworks
changed the title
itdependsnetworks
changed the title
|
Hi @itdependsnetworks, Any chance you guys can cut a new release of nornir-nautobot and move this PR out of draft status? |
|
@jvanderaa would you be able to get the next release of nornir-nautobot at? |
|
@itdependsnetworks I think we are set to put that out. There was one thing that I think we were collaborating on furhter. |
|
@itdependsnetworks release 1.5 for nornir-nautobot is out. |
|
I see that nornir-nautobot v2.5.0 came out with support for this feature, but nautobot-plugin-nornir, which depends on this feature, still depends on nornir-nautobot v2.3.0 I've opened issue nautobot/nautobot-app-nornir#101 to track this |
|
would expect updates to defaults here: |
@jeffkala & @itdependsnetworks Ok, looking at that now. |
At the request of @jeffkala, define the 'jinja_env_trim_blocks' and 'jinja_env_lstrip_blocks' options in the plugin default settings dict
|
@jeffkala per your request, I changed how the defaults are defined. Please review my changes and let me know if that is correct. |
docs/admin/admin_install.md
Outdated
| | sot_agg_transposer | "mypkg.transposer" | None | A string representation of a function that can post-process the graphQL data. | | ||
| | per_feature_bar_width | 0.15 | 0.15 | The width of the table bar within the overview report | | ||
| | per_feature_width | 13 | 13 | The width in inches that the overview table can be. | | ||
| | per_feature_height | 4 | 4 | The height in inches that the overview table can be. | | ||
| | jinja_env_trim_blocks | True | True | A boolean to represent whether the jinja2 option for "trim_blocks" should be enabled for intended config rendering | |
There was a problem hiding this comment.
After getting internal feedback, I think the point @jeffkala and @electro47h is that there are many variables one could set for Jinja, I think the list is:
- block_start_string
- block_end_string
- variable_start_string
- variable_end_string
- comment_start_string
- comment_end_string
- line_statement_prefix
- line_comment_prefix
- trim_blocks
- lstrip_blocks
- newline_sequence
- keep_trailing_newline
- extensions
- optimized
- undefined
- finalize
- autoescape
- loader
- cache_size
- auto_reload
- bytecode_cache
- enable_async
It probably makes sense to support them, as a dictionary, with the 3 variables you have set as defaults. So, there should likely be one variable called jinja_env that is set. If you want to have a magic method of some sort such that anything set with jinja_env_* automagically gets into the dictionary, I could buy that as well, as long as it is in addition to the dictionary method.
There was a problem hiding this comment.
Understood. None of those were possible to set before, but since they will be now, they should be included. This will take a good bit of rework on my end. I'm going to draft this PR and work on it later this week if time allows.
There was a problem hiding this comment.
Question for the masses here. For an option such as 'undefined', how would that look in the nautobot_config.py file for a setting?
from jinja2 import StrictUndefined
Environment(undefined=StrictUndefined, lstrip_blocks=...)
It appears most of the settings are boolean or string values, but a few of the options listed for Jinja are enumerations or classes. If the user intended to customize that setting in their nautobot_config.py file, would they have to add the import, or is there another way to represent that?
There was a problem hiding this comment.
If the user intended to customize that setting in their nautobot_config.py file, would they have to add the import
Yes, they would have to add that to the import within nautobot_config.py. We could work around it, but the complexity is not really worth it.
There was a problem hiding this comment.
Thank you. I have committed what my interpretation of the request is.
I'm out of the office tomorrow and will be unable to test. We also have to get our environment upgraded from 1.5.24 to >=1.6.1 to install this version of the plugin. I will work to get this tested when I can.
Please let me know if this is the correct architecture that you're looking for, or if I need to make changes. Happy to keep plugging away at this.
Per request from @itdependsnetworks, add support for specifying all options passed into the environment creation in a setting named 'jinja_env'
|
Corrected variable naming in the settings, plugin, and docs to match the Jinja Environment variable names since we are now using an exact match to the function parameters that are expected. Commit: f35ef16 |
itdependsnetworks
changed the title
Issue: https://github.com/nautobot/nautobot-plugin-golden-config/issues/525