[cards] PythonCode component
#2196
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
romain-intel
reviewed
Jan 7, 2025
romain-intel
reviewed
Jan 7, 2025
valayDave
force-pushed
the
valay/oss-code-component
branch
from
fe04de4 to
9aef034
Compare
valayDave
commented
Jan 7, 2025
Comment on lines
+144
to
+157
|
|
||
|
|
||
| def create_component_id(component): | ||
| uuid_bit = "".join(uuid.uuid4().hex.split("-"))[:6] | ||
| return type(component).__name__.lower() + "_" + uuid_bit | ||
|
|
||
|
|
||
| def with_default_component_id(func): | ||
| def ret_func(self, *args, **kwargs): | ||
| if self.component_id is None: | ||
| self.component_id = create_component_id(self) | ||
| return func(self, *args, **kwargs) | ||
|
|
||
| return ret_func |
There was a problem hiding this comment.
Just moving things around. Nothing has changed overall.
Comment on lines
-15
to
-28
|
|
||
|
|
||
| def create_component_id(component): | ||
| uuid_bit = "".join(uuid.uuid4().hex.split("-"))[:6] | ||
| return type(component).__name__.lower() + "_" + uuid_bit | ||
|
|
||
|
|
||
| def with_default_component_id(func): | ||
| def ret_func(self, *args, **kwargs): | ||
| if self.component_id is None: | ||
| self.component_id = create_component_id(self) | ||
| return func(self, *args, **kwargs) | ||
|
|
||
| return ret_func |
There was a problem hiding this comment.
Just moved it to a common place so that it can be used in other modules as well.
romain-intel
reviewed
Jan 7, 2025
- Metaflow Card component for rendering a syntax highlighed python function
- Driveby: moved `with_component_id` and `create_component_id` functions to `card.py`
- Default cards now have a code section present too
- Passing flow object to MetaflowCard's init function so that the step function can be retrived by the card when required.
- Any external cards that are using the static __init__ signature of the MetaflowCard will need to change it to the new signature. Any MetaflowCard's using **kwargs in the init signature are safe from the blast radius.
- Example flow :
```
from metaflow import FlowSpec, step, card, current
from metaflow.cards import PythonCode
class PythonCodeDemoFlow(FlowSpec):
@card
@step
def start(self):
# Example 1: Using a function
def sample_function():
x = 1
y = 2
return x + y
current.card.append(PythonCode(sample_function))
# Example 2: Using a string
code = """
def another_function():
return "Hello World"
"""
current.card.append(PythonCode(code_string=code))
self.next(self.end)
@step
def end(self):
pass
if __name__ == '__main__':
PythonCodeDemoFlow()
```
valayDave
force-pushed
the
valay/oss-code-component
branch
from
9aef034 to
4356ff4
Compare
valayDave
commented
Jan 10, 2025
| @@ -66,7 +67,7 @@ class MetaflowCard(object): | |||
| # FIXME document runtime_data | |||
| runtime_data = None | |||
|
|
|||
| def __init__(self, options={}, components=[], graph=None): | |||
There was a problem hiding this comment.
Tweeking function signature here so that default card can access the step function and render it .
There was a problem hiding this comment.
Altered function signatures here for simplicity.
Comment on lines
+500
to
+509
| step_func = getattr(self.flow, self._task.parent.id) | ||
| code_table = SectionComponent( | ||
| title="Task Code", | ||
| contents=[ | ||
| TableComponent( | ||
| data=[[PythonCodeComponent(inspect.getsource(step_func)).render()]] | ||
| ) | ||
| ], | ||
| ).render() | ||
|
|
There was a problem hiding this comment.
Task code is now a part of the default card.
savingoyal
approved these changes
Jan 10, 2025
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.
Metaflow Card component for rendering a syntax highlighed python function
Driveby: moved
with_component_idandcreate_component_idfunctions tocard.pyDefault cards now have a code section present too
Passing flow object to MetaflowCard's init function so that the step function can be retrived by the card when required.
Any external cards that are using the static init signature of the MetaflowCard will need to change it to the new signature. Any MetaflowCard's using **kwargs in the init signature are safe from the blast radius.
Example flow :