generalize ODXLINK reference writing #420
Open
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
writing ODXLINK references should now always work regardless of in which document fragments the reference and the target objects are located. this works by providing three new "magical" global functions to the jinja macros for output: - `set_category_docfrag()`: Specify the document fragment for the ODX category which is applicable for all subsequent macro invocations. - `set_layer_docfrag()`: Specify the document fragment for the diagnostic layer which is applicable for all subsequent macro invocations (for DIAG-LAYER-CONTAINER). - `make_ref_attribs(ref: OdxLinkRef)`: produces all necessary XML attributes required for an ODX link reference XML tag. (i.e., ID-REF, DOCREF and DOCTYPE) internally, these functions require a dictionary parameter for storing "magic" global variables. On the jinja side, this is not necessary because lambda functions are used as wrappers. Signed-off-by: Andreas Lauser <[email protected]> Approved-by: Alexander Walz <[email protected]>
kayoub5
reviewed
Apr 29, 2025
kayoub5
reviewed
Apr 29, 2025
|
|
||
| jinja_env.globals["set_category_docfrag"] = lambda cname, ctype: set_category_docfrag( | ||
| jinja_vars, cname, ctype) | ||
| jinja_env.globals["set_layer_docfrag"] = lambda lname: set_layer_docfrag(jinja_vars, lname) |
There was a problem hiding this comment.
from functools import partial
Suggested change
| jinja_env.globals["set_layer_docfrag"] = lambda lname: set_layer_docfrag(jinja_vars, lname) | |
| jinja_env.globals["set_layer_docfrag"] = partial(set_layer_docfrag, jinja_vars) |
There was a problem hiding this comment.
I think this should stay with the lambdas because partial is much less known (I didn't know it) and it is IMO also less explicit...
thanks to [at]kayoub5 Signed-off-by: Andreas Lauser <[email protected]>
now, there should not be any global variables in this code and it should thus be threadsafe... Signed-off-by: Andreas Lauser <[email protected]>
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.
writing ODXLINK references should now always work regardless of in which document fragments the reference and the target objects are located.
this works by providing three new "magical" global functions to the jinja macros for output:
set_category_docfrag(): Specify the document fragment for the ODX category which is applicable for all subsequent macro invocations.set_layer_docfrag(): Specify the document fragment for the diagnostic layer which is applicable for all subsequent macro invocations (for DIAG-LAYER-CONTAINER).make_ref_attribs(ref: OdxLinkRef): produces all necessary XML attributes required for an ODX link reference XML tag. (i.e., ID-REF, DOCREF and DOCTYPE)internally, these functions require a dictionary parameter for storing "magic" global variables. On the jinja side, this is not necessary because lambda functions are used as wrappers.
Andreas Lauser <[email protected]>, on behalf of MBition GmbH.
Provider Information