plugins JavascriptLink and CssLink

Author: Martin Journois

folium/plugins/__init__.py

@@ -12,3 +12,4 @@
 from .layer import Layer, LayerControl
 from .geo_json import GeoJson
 from .timestamped_geo_json import TimestampedGeoJson
+from .links import JavascriptLink, CssLink

folium/plugins/links.py

@@ -0,0 +1,69 @@
+# -*- coding: utf-8 -*-
+"""
+Links
+-----
+
+Plugins to add links into the header of the file.
+
+"""
+
+#from six import Module_six_moves_urllib as urllib
+#urlopen = urllib.request.urlopen
+import sys, urllib
+PY3 = sys.version_info[0] == 3
+urlopen = urllib.request.urlopen if PY3 else urllib.urlopen
+
+from .plugin import Plugin
+
+class Link(Plugin):
+    def __init__(self, url, download=False):
+        """Create a link object based on a url.
+        Parameters
+        ----------
+            url : str
+                The url to be linked
+            download : bool, default False
+                Whether the target document shall be loaded right now.
+        """
+        self.url = url
+        self.code = None
+        if download:
+            self.code = urlopen(self.url).read()
+    def render_header(self, nb, embedded=False):
+        """Generates the Header part of the plugin."""
+        return self.render(embedded=embedded)
+
+class JavascriptLink(Link):
+    def render(self, embedded=False):
+        """Renders the object.
+        
+        Parameters
+        ----------
+            embedded : bool, default False
+                Whether the code shall be embedded explicitely in the render.
+        """
+        if embedded:
+            if self.code is None:
+                self.code = urlopen(self.url).read()
+            return '<script>{}</script>'.format(self.code)
+        else:
+            return '<script src="{}"></script>'.format(self.url)
+
+class CssLink(Link):
+    def render(self, embedded=False):
+        """Renders the object.
+        
+        Parameters
+        ----------
+            embedded : bool, default False
+                Whether the code shall be embedded explicitely in the render.
+        """
+        if embedded:
+            if self.code is None:
+                self.code = urlopen(self.url).read()
+            return '<style>{}</style>'.format(self.code)
+        else:
+            return '<link rel="stylesheet" href="{}" />'.format(self.url)
+            
+
+            

tests/test_plugins.py

@@ -11,6 +11,19 @@
 
 class testPlugins(object):
     '''Test class for Folium plugins'''
+    def test_javascript_link(self):
+        j = plugins.JavascriptLink("https://cdnjs.cloudflare.com/ajax/libs/leaflet/0.7.3/leaflet.js")
+        j.render(embedded=False)
+        j.render(embedded=True)
+        j.render_header(0)
+        j.render_html(0)
+
+    def test_css_link(self):
+        c = plugins.CssLink("https://cdnjs.cloudflare.com/ajax/libs/leaflet/0.7.3/leaflet.css")
+        c.render(embedded=False)
+        c.render(embedded=True)
+        c.render_header(0)
+        c.render_html(0)
 
     def test_scroll_zoom_toggler(self):
         mapa = folium.Map([45.,3.], zoom_start=4)