Tooltips should be html.escaped

ArtificialIntelligenceToolkit · Aug 10, 2017 · bd00dcd · bd00dcd
1 parent 25adb41
commit bd00dcd
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 5 deletions.
diff --git a/conx/layers.py b/conx/layers.py
@@ -30,6 +30,7 @@
 from functools import reduce
 import sys
 import inspect
+import html
 import re
 import os
 
@@ -289,15 +290,16 @@ def tooltip(self):
             if key in ["name"]:
                 continue
             retval += "\n %s = %s" % (key, self.params[key])
-        return retval
+        return html.escape(retval)
 
 class Layer(_BaseLayer):
     """
     The default layer type. Will create either an InputLayer, or DenseLayer,
     depending on its context after :any:`Network.connect`.
 
     Arguments:
-        name: The name of the layer. Must be unique in this network.
+        name: The name of the layer. Must be unique in this network. Should
+           not contain special HTML characters.
 
     Examples:
         >>> layer = Layer("input", 10)

diff --git a/conx/network.py b/conx/network.py
@@ -27,6 +27,7 @@
 import signal
 import numbers
 import base64
+import html
 import copy
 import io
 import PIL
@@ -51,7 +52,8 @@ class Network():
     The main class for the conx neural network package.
 
     Arguments:
-        name: Required. The name of the network.
+        name: Required. The name of the network. Should not contain special HTML
+           characters.
         sizes: Optional numbers. Defines the sizes of layers of a sequential
            network. These will be created, added, and connected automatically.
         config: Configuration overrides for the network.
@@ -1491,7 +1493,7 @@ def build_svg(self, opts={}):
                     rect_extra = 0
                     if rect_width < 20:
                         rect_extra = 10
-                    tooltip = self.describe_connection_to(self[layer_name], out)
+                    tooltip = html.escape(self.describe_connection_to(self[layer_name], out))
                     svg += arrow_rect.format(**{"tooltip": tooltip,
                                                 "rx": min(x2, x1) - rect_extra,
                                                 "ry": min(y2, y1) + 2, # bring down
@@ -1501,7 +1503,7 @@ def build_svg(self, opts={}):
                     if out.name not in positioning:
                         continue
                     # draw an arrow between layers:
-                    tooltip = self.describe_connection_to(self[layer_name], out)
+                    tooltip = html.escape(self.describe_connection_to(self[layer_name], out))
                     x2 = positioning[out.name]["x"] + positioning[out.name]["width"]/2
                     y2 = positioning[out.name]["y"] + positioning[out.name]["height"]
                     svg += arrow_svg.format(