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

* Store a plain repr for when a notebook is untrusted (github)

* Run quickstart notebook

* Run tutorial notebooks that have reprs

Author: jsignell

docs/quickstart.ipynb

@@ -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))
 

docs/tutorials/how-to-create-stac-catalogs.ipynb

@@ -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() %}
@@ -42,4 +53,5 @@
             {% endfor %}
         </ul>
     </div>
-</div>
+</div>
+</div>

docs/tutorials/pystac-introduction.ipynb

@@ -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))
 

pystac/asset.py

@@ -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))
 

pystac/html/JSON.jinja2

@@ -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))
 

pystac/item_collection.py

@@ -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))