Remove temporary DOT files #884
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
added 2 commits
May 3, 2024 19:32
Hamilton visualizations rely on the graphviz library. It defines graphs using the DOT language, which defines one statement per line using a string. Previously, Hamilton used `graphviz.Digraph.render()` to produce visualizations. This has the side-effect of producing an intermediary DOT file on disk. This is most often of no use and clutters the directory. Now, we are switching to `graphviz.Digraph.pipe()` to write bytes directly to an open file. Tests were updated accordingly. The keyword argument `keep_dot` was added to viz functions in case users still want this DOT file to be produced. It allows to rerender the viz with a different style without re-executing the Hamilton code. It could be useful when iterating over custom styling.
skrawcz
reviewed
May 4, 2024
| @@ -894,7 +899,7 @@ def display( | |||
| custom_style_function=custom_style_function, | |||
| config=config, | |||
| ) | |||
| kwargs = {"view": False, "format": "png"} # default format = png | |||
| kwargs = {"format": "png"} # default format = png | |||
There was a problem hiding this comment.
graphviz.Digraph.pipe() doesn't have a view kwarg. Forgot to add it back for keep_dot=True though.
skrawcz
approved these changes
May 5, 2024
skrawcz
added a commit
that referenced
this pull request
May 5, 2024
Merged
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.
Hamilton visualizations rely on the graphviz library.
It defines graphs using the DOT language, which
defines one statement per line using a string.
Previously, Hamilton used
graphviz.Digraph.render()to produce visualizations. This has the side-effect
of producing an intermediary DOT file on disk. This
is most often of no use and clutters the directory.
Now, we are switching to
graphviz.Digraph.pipe()to write bytes directly to an open file. Tests were
updated accordingly.
The keyword argument
keep_dotwas added to vizfunctions in case users still want this DOT file
to be produced. It allows to rerender the viz with
a different style without re-executing the Hamilton
code. It could be useful when iterating over custom
styling.
How I tested this