Skip to content

Include a plain text repr for when notebook is untrusted. #1577

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

Merged
merged 3 commits into from
Sep 11, 2025
Merged

Include a plain text repr for when notebook is untrusted. #1577

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
37c1dc3
Store a plain repr for when a notebook is untrusted (github)
jsignell Sep 11, 2025
c60e7cf
Run quickstart notebook
jsignell Sep 11, 2025
9e8ed9f
Run tutorial notebooks that have reprs
jsignell Sep 11, 2025
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
999 changes: 621 additions & 378 deletions docs/quickstart.ipynb
View file
Open in desktop

Large diffs are not rendered by default.

2,488 changes: 1,610 additions & 878 deletions docs/tutorials/how-to-create-stac-catalogs.ipynb
View file
Open in desktop

Large diffs are not rendered by default.

3,538 changes: 1,918 additions & 1,620 deletions docs/tutorials/pystac-introduction.ipynb
View file
Open in desktop

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion pystac/asset.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -185,7 +185,7 @@ def _repr_html_(self) -> str:
jinja_env = get_jinja_env()
if jinja_env:
template = jinja_env.get_template("JSON.jinja2")
return str(template.render(dict=self.to_dict()))
return str(template.render(dict=self.to_dict(), plain=escape(repr(self))))
else:
return escape(repr(self))

Expand Down
16 changes: 14 additions & 2 deletions pystac/html/JSON.jinja2
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,8 +29,19 @@
color: rgb(0, 128, 0);
font-weight: 700;
}
.pystac-wrap {
display: block !important;
}
.pystac-text-repr-fallback {
/* fallback to plain text repr when CSS is not injected (untrusted notebook) */
display: none;
}
</style>
<div class="jp-RenderedJSON jp-mod-trusted jp-OutputArea-output">
<div>
<div class="pystac-text-repr-fallback">
{{ plain }}
</div>
<div class="jp-RenderedJSON jp-mod-trusted jp-OutputArea-output pystac-wrap" style='display:none'>
<div class="container" style="line-height: normal;">
<ul style="padding: 0px; margin: 0px; list-style: none; display: block;">
{% for key, value in dict.items() %}
Expand All @@ -42,4 +53,5 @@
{% endfor %}
</ul>
</div>
</div>
</div>
</div>
2 changes: 1 addition & 1 deletion pystac/item_collection.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -150,7 +150,7 @@ def _repr_html_(self) -> str:
jinja_env = get_jinja_env()
if jinja_env:
template = jinja_env.get_template("JSON.jinja2")
return str(template.render(dict=self.to_dict()))
return str(template.render(dict=self.to_dict(), plain=escape(repr(self))))
else:
return escape(repr(self))

Expand Down
6 changes: 5 additions & 1 deletion pystac/link.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -275,7 +275,11 @@ def _repr_html_(self) -> str:
jinja_env = get_jinja_env()
if jinja_env:
template = jinja_env.get_template("JSON.jinja2")
return str(template.render(dict=self.to_dict()))
return str(
template.render(
dict=self.to_dict(transform_href=False), plain=escape(repr(self))
)
)
else:
return escape(repr(self))

Expand Down
2 changes: 1 addition & 1 deletion pystac/provider.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ def _repr_html_(self) -> str:
jinja_env = get_jinja_env()
if jinja_env:
template = jinja_env.get_template("JSON.jinja2")
return str(template.render(dict=self.to_dict()))
return str(template.render(dict=self.to_dict(), plain=escape(repr(self))))
else:
return escape(repr(self))

Expand Down
6 changes: 5 additions & 1 deletion pystac/stac_object.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -587,7 +587,11 @@ def _repr_html_(self) -> str:
jinja_env = get_jinja_env()
if jinja_env:
template = jinja_env.get_template("JSON.jinja2")
return str(template.render(dict=self.to_dict(transform_hrefs=False)))
return str(
template.render(
dict=self.to_dict(transform_hrefs=False), plain=escape(repr(self))
)
)
else:
return escape(repr(self))

Expand Down
Loading