This repository has been archived by the owner on Jul 3, 2023. It is now read-only.
Exposes passing kwargs to graphviz object #125
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
skrawcz
force-pushed
the
expose_graphviz_kwargs
branch
from
1abbedf
to
77b4f91
Compare
elijahbenizzy
approved these changes
May 1, 2022
| except ImportError as e: | ||
| logger.warning(f'Unable to import {e}', exc_info=True) | ||
|
|
||
| def visualize_execution(self, | ||
| final_vars: List[str], | ||
| output_file_path: str, | ||
| render_kwargs: dict, | ||
| inputs: Dict[str, Any] = None): | ||
| inputs: Dict[str, Any] = None, | ||
| graphviz_kwargs: dict = None): |
There was a problem hiding this comment.
Can you explain the difference between this and **render_kwargs? I think it makes sense but its not obvious.
There was a problem hiding this comment.
Render is called after you construct the graph and want to create an image from it.
https://graphviz.readthedocs.io/en/stable/api.html#graphviz.Graph.render
This should be a backwards compatible API change for everything. To be able to control, for instance the ratio, of the produced image, it's not a render time argument. Instead, it's a property of the graph. To be able to manipulate it, we need to wire through passing in attributes. e.g. https://graphviz.org/doc/info/attrs.html shows what could be set. These attributes are either graph, node, or edge attributes. The kwargs I'm specifically trying to expose are: ``` graph_attr – Mapping of (attribute, value) pairs for the graph. node_attr – Mapping of (attribute, value) pairs set for all nodes. edge_attr – Mapping of (attribute, value) pairs set for all edges. ``` The above was taken from https://graphviz.readthedocs.io/en/stable/api.html?highlight=ratio#digraph. Note, this will enable anything else to be also passed to the graph, which I think is a useful thing too. Since that will allow someone who knows graphviz to really customize it I think.
skrawcz
force-pushed
the
expose_graphviz_kwargs
branch
from
77b4f91
to
a669727
Compare
12 tasks
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
This should be a backwards compatible API change for everything.
To be able to control, for instance the ratio, of the produced image,
it's not a render time argument. Instead, it's a property of the graph.
To be able to manipulate it, we need to wire through passing in attributes.
e.g. https://graphviz.org/doc/info/attrs.html shows what could be set.
These attributes are either graph, node, or edge attributes.
The kwargs I'm specifically trying to expose are:
The above was taken from https://graphviz.readthedocs.io/en/stable/api.html?highlight=ratio#digraph.
Note, this will enable anything else to be also passed to the graph, which I
think is a useful thing too. Since that will allow someone who knows graphviz
to really customize it I think.
Changes
graphviz_kwargsparameter and wires it through to all the displays.Testing
graphviz_kwargs.Notes
Checklist
Testing checklist
Python - local testing