Moved __init__ docstrings to object

Author: Martin Journois

folium/colormap.py

@@ -260,11 +260,14 @@ def _base(x):
 
 
 class ColorMap(MacroElement):
-    """A generic class for creating colormaps."""
+    """A generic class for creating colormaps.
+
+    Parameters
+    ----------
+    TODO: docstring
+    """
 
     def __init__(self, vmin=0., vmax=1., caption=""):
-        """
-        """
         super(ColorMap, self).__init__()
         self._name = 'ColorMap'
 
@@ -276,6 +279,7 @@ def __init__(self, vmin=0., vmax=1., caption=""):
         self._template = self._env.get_template('color_scale.js')
 
     def render(self, **kwargs):
+        """TODO: docstring"""
         self.color_domain = [self.vmin + (self.vmax-self.vmin) * k/499. for
                              k in range(500)]
         self.color_range = [self.__call__(x) for x in self.color_domain]
@@ -340,33 +344,32 @@ def _repr_html_(self):
 
 
 class LinearColormap(ColorMap):
+    """Creates a ColorMap based on linear interpolation of a set of colors
+    over a given index.
+
+    Parameters
+    ----------
+    colors : list-like object
+        The set of colors to be used for interpolation.
+        Colors can be provided in the form:
+        * tuples of int between 0 and 255 (e.g: `(255,255,0)` or
+          `(255, 255, 0, 255)`)
+        * tuples of floats between 0. and 1. (e.g: `(1.,1.,0.)` or
+          `(1., 1., 0., 1.)`)
+        * HTML-like string (e.g: `"#ffff00`)
+        * a color name or shortcut (e.g: `"y"` or `"yellow"`)
+    index : list of floats, default None
+        The values corresponding to each color.
+        It has to be sorted, and have the same length as `colors`.
+        If None, a regular grid between `vmin` and `vmax` is created.
+    vmin : float, default 0.
+        The minimal value for the colormap.
+        Values lower than `vmin` will be bound directly to `colors[0]`.
+    vmax : float, default 1.
+        The maximal value for the colormap.
+        Values higher than `vmax` will be bound directly to `colors[-1]`.
+    """
     def __init__(self, colors, index=None, vmin=0., vmax=1., caption=""):
-        """Creates a ColorMap based on linear interpolation of a set of colors
-        over a given index.
-
-        Parameters
-        ----------
-        colors : list-like object
-            The set of colors to be used for interpolation.
-            Colors can be provided in the form:
-            * tuples of int between 0 and 255 (e.g: `(255,255,0)` or
-              `(255, 255, 0, 255)`)
-            * tuples of floats between 0. and 1. (e.g: `(1.,1.,0.)` or
-              `(1., 1., 0., 1.)`)
-            * HTML-like string (e.g: `"#ffff00`)
-            * a color name or shortcut (e.g: `"y"` or `"yellow"`)
-        index : list of floats, default None
-            The values corresponding to each color.
-            It has to be sorted, and have the same length as `colors`.
-            If None, a regular grid between `vmin` and `vmax` is created.
-        vmin : float, default 0.
-            The minimal value for the colormap.
-            Values lower than `vmin` will be bound directly to `colors[0]`.
-        vmax : float, default 1.
-            The maximal value for the colormap.
-            Values higher than `vmax` will be bound directly to `colors[-1]`.
-
-        """
         super(LinearColormap, self).__init__(vmin=vmin, vmax=vmax,
                                              caption=caption)
 
@@ -522,32 +525,33 @@ def scale(self, vmin=0., vmax=1.):
 
 
 class StepColormap(ColorMap):
-    def __init__(self, colors, index=None, vmin=0., vmax=1., caption=""):
-        """Creates a ColorMap based on stepwise constant colorfunction.
+    """Creates a ColorMap based on linear interpolation of a set of colors
+    over a given index.
+
+    Parameters
+    ----------
+    colors : list-like object
+        The set of colors to be used for interpolation.
+        Colors can be provided in the form:
+        * tuples of int between 0 and 255 (e.g: `(255,255,0)` or
+          `(255, 255, 0, 255)`)
+        * tuples of floats between 0. and 1. (e.g: `(1.,1.,0.)` or
+          `(1., 1., 0., 1.)`)
+        * HTML-like string (e.g: `"#ffff00`)
+        * a color name or shortcut (e.g: `"y"` or `"yellow"`)
+    index : list of floats, default None
+        The values corresponding to each color.
+        It has to be sorted, and have the same length as `colors`.
+        If None, a regular grid between `vmin` and `vmax` is created.
+    vmin : float, default 0.
+        The minimal value for the colormap.
+        Values lower than `vmin` will be bound directly to `colors[0]`.
+    vmax : float, default 1.
+        The maximal value for the colormap.
+        Values higher than `vmax` will be bound directly to `colors[-1]`.
 
-        Parameters
-        ----------
-        colors : list-like object
-            The set of colors to be used.
-            Colors can be provided in the form:
-            * tuples of int between 0 and 255 (e.g: `(255, 255, 0)` or
-              `(255, 255, 0, 255)`)
-            * tuples of floats between 0. and 1. (e.g: `(1., 1., 0.)` or
-              `(1., 1., 0., 1.)`)
-            * HTML-like string (e.g: `"#ffff00`)
-            * a color name or shortcut (e.g: `"y"` or `"yellow"`)
-        index : list of floats, default None
-            The values corresponding to each color.
-            Must be be sorted and its length must be equal to `len(colors)+1`.
-            If None, a regular grid between `vmin` and `vmax` is created.
-        vmin : float, default 0.
-            The minimal value for the colormap.
-            Values lower than `vmin` will be bound directly to `colors[0]`.
-        vmax : float, default 1.
-            The maximal value for the colormap.
-            Values higher than `vmax` will be bound directly to `colors[-1]`.
-
-        """
+    """
+    def __init__(self, colors, index=None, vmin=0., vmax=1., caption=""):
         super(StepColormap, self).__init__(vmin=vmin, vmax=vmax,
                                            caption=caption)
 
@@ -609,7 +613,6 @@ def scale(self, vmin=0., vmax=1.):
 
 class _LinearColormaps(object):
     """A class for hosting the list of built-in linear colormaps."""
-
     def __init__(self):
         self._schemes = _schemes.copy()
         self._colormaps = {key: LinearColormap(val) for

folium/element.py

@@ -21,9 +21,13 @@
 
 class Element(object):
     """Basic Element object that does nothing.
-    Other Elements may inherit from this one."""
+    Other Elements may inherit from this one.
+
+    Parameters
+    ----------
+    TODO: docstring.
+    """
     def __init__(self, template=None, template_name=None):
-        """Creates a Element."""
         self._name = 'Element'
         self._id = uuid4().hex
         self._env = ENV
@@ -144,6 +148,8 @@ def save(self, outfile, close_file=True, **kwargs):
 class Link(Element):
     """Link
     ----
+
+    TODO: docstring.
     """
     def get_code(self):
         """TODO : docstring."""
@@ -159,16 +165,15 @@ def to_dict(self, depth=-1, **kwargs):
 
 
 class JavascriptLink(Link):
-    """TODO: docstring."""
+    """Create a JavascriptLink 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.
+    """
     def __init__(self, url, download=False):
-        """Create a JavascriptLink 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.
-        """
         super(JavascriptLink, self).__init__()
         self._name = 'JavascriptLink'
         self.url = url
@@ -186,16 +191,15 @@ def __init__(self, url, download=False):
 
 
 class CssLink(Link):
-    """TODO: docstring."""
+    """Create a CssLink 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.
+    """
     def __init__(self, url, download=False):
-        """Create a CssLink 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.
-        """
         super(CssLink, self).__init__()
         self._name = 'CssLink'
         self.url = url
@@ -247,27 +251,26 @@ def __init__(self, url, download=False):
 
 
 class Figure(Element):
-    """TODO: docstring."""
+    """Create a Figure object, to plot things into it.
+
+    Parameters
+    ----------
+    width : str, default "100%"
+        The width of the Figure.
+        It may be a percentage or pixel value (like "300px").
+    height : str, default None
+        The height of the Figure.
+        It may be a percentage or a pixel value (like "300px").
+    ratio : str, default "60%"
+        A percentage defining the aspect ratio of the Figure.
+        It will be ignored if height is not None.
+    figsize : tuple of two int, default None
+        If you're a matplotlib addict, you can overwrite width and
+        height. Values will be converted into pixels in using 60 dpi.
+        For example figsize=(10, 5) will result in
+        width="600px", height="300px".
+    """
     def __init__(self, width="100%", height=None, ratio="60%", figsize=None):
-        """Create a Figure object, to plot things into it.
-
-        Parameters
-        ----------
-        width : str, default "100%"
-            The width of the Figure.
-            It may be a percentage or pixel value (like "300px").
-        height : str, default None
-            The height of the Figure.
-            It may be a percentage or a pixel value (like "300px").
-        ratio : str, default "60%"
-            A percentage defining the aspect ratio of the Figure.
-            It will be ignored if height is not None.
-        figsize : tuple of two int, default None
-            If you're a matplotlib addict, you can overwrite width and
-            height. Values will be converted into pixels in using 60 dpi.
-            For example figsize=(10, 5) will result in
-            width="600px", height="300px".
-        """
         super(Figure, self).__init__()
         self._name = 'Figure'
         self.header = Element()
@@ -398,21 +401,21 @@ def add_subplot(self, x, y, n, margin=0.05):
 
 
 class Html(Element):
-    """A basic Element for embedding HTML."""
-    def __init__(self, data, width="100%", height="100%"):
-        """Create an HTML div object for embedding data.
+    """Create an HTML div object for embedding data.
+
+    Parameters
+    ----------
+    data : str
+        The HTML data to be embedded.
+    width : int or str, default '100%'
+        The width of the output div element.
+        Ex: 120 , '120px', '80%'
+    height : int or str, default '100%'
+        The height of the output div element.
+        Ex: 120 , '120px', '80%'
+    """
 
-        Parameters
-        ----------
-        data : str
-            The HTML data to be embedded.
-        width : int or str, default '100%'
-            The width of the output div element.
-            Ex: 120 , '120px', '80%'
-        height : int or str, default '100%'
-            The height of the output div element.
-            Ex: 120 , '120px', '80%'
-        """
+    def __init__(self, data, width="100%", height="100%"):
         super(Html, self).__init__()
         self._name = 'Html'
         self.data = data
@@ -428,10 +431,14 @@ def __init__(self, data, width="100%", height="100%"):
 
 
 class Div(Figure):
-    """TODO: docstring."""
+    """Create a Map with Folium and Leaflet.js.
+
+    Parameters
+    ----------
+    TODO: docstring.
+    """
     def __init__(self, width='100%', height='100%',
                  left="0%", top="0%", position='relative'):
-        """Create a Map with Folium and Leaflet.js."""
         super(Figure, self).__init__()
         self._name = 'Div'
 
@@ -517,30 +524,29 @@ def _repr_html_(self, **kwargs):
 
 
 class IFrame(Element):
-    """TODO: docstring."""
+    """Create a Figure object, to plot things into it.
+
+    Parameters
+    ----------
+    html : str, default None
+        Eventual HTML code that you want to put in the frame.
+    width : str, default "100%"
+        The width of the Figure.
+        It may be a percentage or pixel value (like "300px").
+    height : str, default None
+        The height of the Figure.
+        It may be a percentage or a pixel value (like "300px").
+    ratio : str, default "60%"
+        A percentage defining the aspect ratio of the Figure.
+        It will be ignored if height is not None.
+    figsize : tuple of two int, default None
+        If you're a matplotlib addict, you can overwrite width and
+        height. Values will be converted into pixels in using 60 dpi.
+        For example figsize=(10, 5) will result in
+        width="600px", height="300px".
+    """
     def __init__(self, html=None, width="100%", height=None, ratio="60%",
                  figsize=None):
-        """Create a Figure object, to plot things into it.
-
-        Parameters
-        ----------
-        html : str, default None
-            Eventual HTML code that you want to put in the frame.
-        width : str, default "100%"
-            The width of the Figure.
-            It may be a percentage or pixel value (like "300px").
-        height : str, default None
-            The height of the Figure.
-            It may be a percentage or a pixel value (like "300px").
-        ratio : str, default "60%"
-            A percentage defining the aspect ratio of the Figure.
-            It will be ignored if height is not None.
-        figsize : tuple of two int, default None
-            If you're a matplotlib addict, you can overwrite width and
-            height. Values will be converted into pixels in using 60 dpi.
-            For example figsize=(10, 5) will result in
-            width="600px", height="300px".
-        """
         super(IFrame, self).__init__()
         self._name = 'IFrame'
 
@@ -597,7 +603,6 @@ class MacroElement(Element):
             {% endmacro %}
     """
     def __init__(self):
-        """Creates a MacroElement object."""
         super(MacroElement, self).__init__()
         self._name = 'MacroElement'