Skip to content

Treat directory names as text in display objects #15413

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
hao0x1 wants to merge 1 commit into
base: main
Choose a base branch
from
+53 −1
Open

Treat directory names as text in display objects #15413

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion IPython/core/display.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -325,7 +325,7 @@ def __init__(self, data=None, url=None, filename=None, metadata=None):
url = data
filename = None
data = None
elif _safe_exists(data) and filename is None:
elif _safe_exists(data) and not os.path.isdir(data) and filename is None:
url = None
filename = data
data = None
Expand Down
52 changes: 52 additions & 0 deletions tests/test_display_2.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -323,6 +323,58 @@ def test_displayobject_repr():
assert repr(j) == "<IPython.core.display.Javascript object>"


@pytest.mark.parametrize("display_class", [display.Markdown, display.HTML])
@pytest.mark.parametrize("data", [".", "..", "notes"])
def test_displayobject_directory_text(display_class, data, tmp_path, monkeypatch):
monkeypatch.chdir(tmp_path)
(tmp_path / "notes").mkdir()

obj = display_class(data)

assert obj.data == data
assert obj.filename is None


@pytest.mark.parametrize(
"display_class, path_type",
[(display.Markdown, str), (display.Markdown, Path), (display.HTML, str)],
)
def test_displayobject_file_data(display_class, path_type, tmp_path):
path = tmp_path / "notes.txt"
path.write_text("Some text", encoding="utf-8")

obj = display_class(path_type(path))

assert obj.data == "Some text"
assert obj.filename == str(path)


@dec.skip_win32
@pytest.mark.parametrize("is_directory", [False, True])
def test_displayobject_symlink_data(is_directory, tmp_path):
target = tmp_path / "target"
if is_directory:
target.mkdir()
else:
target.write_text("Some text", encoding="utf-8")
link = tmp_path / "link"
link.symlink_to(target, target_is_directory=is_directory)

obj = display.Markdown(str(link))

if is_directory:
assert obj.data == str(link)
assert obj.filename is None
else:
assert obj.data == "Some text"
assert obj.filename == str(link)


def test_displayobject_explicit_directory_filename(tmp_path):
with pytest.raises(OSError):
display.Markdown(filename=tmp_path)


@mock.patch("warnings.warn")
def test_encourage_iframe_over_html(m_warn):
display.HTML()
Expand Down
Loading