Skip to content

Commit

Permalink
fix: Pipeline - disable autoshow on Jupyter (#7397)
Browse files Browse the repository at this point in the history
* try

* fix docstring

* simplify tests

* add release note
  • Loading branch information
anakin87 authored and silvanocerza committed Apr 8, 2024
1 parent 80850df commit fb19ae6
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 27 deletions.
6 changes: 0 additions & 6 deletions haystack/core/pipeline/pipeline.py
Original file line number Diff line number Diff line change
Expand Up @@ -86,13 +86,7 @@ def __eq__(self, other) -> bool:
def __repr__(self) -> str:
"""
Returns a text representation of the Pipeline.
If this runs in a Jupyter notebook, it will instead display the Pipeline image.
"""
if is_in_jupyter():
# If we're in a Jupyter notebook we want to display the image instead of the text repr.
self.show()
return ""

res = f"{object.__repr__(self)}\n"
if self.metadata:
res += "🧱 Metadata\n"
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
enhancements:
- |
In Jupyter notebooks, the image of the Pipeline will no longer be displayed automatically.
The textual representation of the Pipeline will be displayed.
To display the Pipeline image, use the `show` method of the Pipeline object.
23 changes: 2 additions & 21 deletions test/core/pipeline/test_pipeline.py
Original file line number Diff line number Diff line change
Expand Up @@ -281,8 +281,7 @@ def test_get_component_name_not_added_to_pipeline():
assert pipe.get_component_name(some_component) == ""


@patch("haystack.core.pipeline.pipeline.is_in_jupyter")
def test_repr(mock_is_in_jupyter):
def test_repr():
pipe = Pipeline(metadata={"test": "test"}, max_loops_allowed=42)
pipe.add_component("add_two", AddFixedValue(add=2))
pipe.add_component("add_default", AddFixedValue())
Expand All @@ -302,26 +301,8 @@ def test_repr(mock_is_in_jupyter):
" - add_two.result -> double.value (int)\n"
" - double.value -> add_default.value (int)\n"
)
# Simulate not being in a notebook
mock_is_in_jupyter.return_value = False
assert repr(pipe) == expected_repr


@patch("haystack.core.pipeline.pipeline.is_in_jupyter")
def test_repr_in_notebook(mock_is_in_jupyter):
pipe = Pipeline(metadata={"test": "test"}, max_loops_allowed=42)
pipe.add_component("add_two", AddFixedValue(add=2))
pipe.add_component("add_default", AddFixedValue())
pipe.add_component("double", Double())
pipe.connect("add_two", "double")
pipe.connect("double", "add_default")

# Simulate being in a notebook
mock_is_in_jupyter.return_value = True

with patch.object(Pipeline, "show") as mock_show:
assert repr(pipe) == ""
mock_show.assert_called_once_with()
assert repr(pipe) == expected_repr


def test_run_raises_if_max_visits_reached():
Expand Down

0 comments on commit fb19ae6

Please sign in to comment.