Add Python Dependency Deck #2264
There are no files selected for viewing
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
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
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -86,3 +86,73 @@ | |||||
| css = formatter.get_style_defs(".highlight").replace("#fff0f0", "#ffffff") | ||||||
| html = highlight(source_code, PythonLexer(), formatter) | ||||||
| return f"<style>{css}</style>{html}" | ||||||
|
|
||||||
|
|
||||||
| class PythonDependencyRenderer: | ||||||
| """ | ||||||
| PythonDependencyDeck is a deck that contains information about packages installed via pip. | ||||||
| """ | ||||||
|
|
||||||
| def __init__(self, title: str = "Python Dependencies"): | ||||||
|
There was a problem hiding this comment.
Suggested change
|
||||||
| self._title = title | ||||||
|
|
||||||
| def to_html(self) -> str: | ||||||
| import json | ||||||
| import subprocess | ||||||
| import sys | ||||||
|
|
||||||
| from flytekit.loggers import logger | ||||||
|
|
||||||
| try: | ||||||
| installed_packages = json.loads( | ||||||
| subprocess.check_output([sys.executable, "-m", "pip", "list", "--format", "json"]) | ||||||
| ) | ||||||
| requirements_txt = subprocess.check_output(["pip", "freeze"]).decode("utf-8").replace("\\n", "\n").rstrip() | ||||||
jasonlai1218 marked this conversation as resolved.
Show resolved
Hide resolved
|
||||||
| except subprocess.CalledProcessError as e: | ||||||
| logger.error(f"Error occurred while fetching installed packages: {e}") | ||||||
| return "" | ||||||
|
There was a problem hiding this comment. Having an empty HTML feels like a bad dev experience. I think it's worth having an error message:
Suggested change
|
||||||
|
|
||||||
| markdown_table = ( | ||||||
| "<table>\n<tr>\n<th style='text-align:left;'>Name</th>\n<th style='text-align:left;'>Version</th>\n</tr>\n" | ||||||
| ) | ||||||
jasonlai1218 marked this conversation as resolved.
Show resolved
Hide resolved
|
||||||
|
|
||||||
| for entry in installed_packages: | ||||||
| markdown_table += f"<tr>\n<td>{entry['name']}</td>\n<td>{entry['version']}</td>\n</tr>\n" | ||||||
|
|
||||||
| markdown_table += "</table>" | ||||||
|
|
||||||
| table = MarkdownRenderer().to_html(markdown_table) | ||||||
| html = f""" | ||||||
| <!DOCTYPE html> | ||||||
| <html lang="en"> | ||||||
| <head> | ||||||
| <meta charset="UTF-8"> | ||||||
| <meta name="viewport" content="width=device-width, initial-scale=1.0"> | ||||||
| <title>Flyte Dependencies</title> | ||||||
| <script> | ||||||
| async function copyTable() {{ | ||||||
| var requirements_txt = document.getElementById('requirements_txt'); | ||||||
|
|
||||||
| try {{ | ||||||
| await navigator.clipboard.writeText(requirements_txt.innerText); | ||||||
| }} catch (err) {{ | ||||||
| console.log('Error accessing the clipboard: ' + err); | ||||||
| }} | ||||||
| }} | ||||||
| </script> | ||||||
| </head> | ||||||
| <body> | ||||||
|
|
||||||
| <button onclick="copyTable()"> | ||||||
|
There was a problem hiding this comment. @eapolinario This copy button does not work. I get this error in the console:
If we can not get this to work, I'm okay with removing the copy button and just showing the table. There was a problem hiding this comment. This is blocked on flyteorg/flyteconsole#852. There was a problem hiding this comment. That just got merged, so next Flyte release is going to have this. |
||||||
| <span>Copy table as requirements.txt</span> | ||||||
| </button> | ||||||
| <br><br><br> | ||||||
|
There was a problem hiding this comment.
Suggested change
|
||||||
|
|
||||||
| {table} | ||||||
|
|
||||||
| <div id="requirements_txt" style="display:none">{requirements_txt}</div> | ||||||
|
|
||||||
| </body> | ||||||
| </html> | ||||||
| """ | ||||||
| return html | ||||||
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
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nit: Making this shorter looks better in the UI:
"Python Dependencies using a second line":
