ENH: Add render_links option to DataFrame to_html()

Author: benjaminarjun

pandas/core/frame.py

@@ -2093,8 +2093,8 @@ def to_html(self, buf=None, columns=None, col_space=None, header=True,
                 index=True, na_rep='NaN', formatters=None, float_format=None,
                 sparsify=None, index_names=True, justify=None, max_rows=None,
                 max_cols=None, show_dimensions=False, decimal='.',
-                bold_rows=True, classes=None, escape=True,
-                notebook=False, border=None, table_id=None):
+                bold_rows=True, classes=None, escape=True, notebook=False,
+                border=None, table_id=None, render_links=False):
         """
         Render a DataFrame as an HTML table.
         %(shared_params)s
@@ -2116,6 +2116,12 @@ def to_html(self, buf=None, columns=None, col_space=None, header=True,
             A css id is included in the opening `<table>` tag if specified.
 
             .. versionadded:: 0.23.0
+
+        render_links : boolean, default False
+            Convert URLs to HTML links.
+
+            .. versionadded:: 0.24.0
+
         %(returns)s
         See Also
         --------
@@ -2137,7 +2143,8 @@ def to_html(self, buf=None, columns=None, col_space=None, header=True,
                                            max_rows=max_rows,
                                            max_cols=max_cols,
                                            show_dimensions=show_dimensions,
-                                           decimal=decimal, table_id=table_id)
+                                           decimal=decimal, table_id=table_id,
+                                           render_links=render_links)
         # TODO: a generic formatter wld b in DataFrameFormatter
         formatter.to_html(classes=classes, notebook=notebook, border=border)
 

pandas/io/formats/format.py

@@ -383,7 +383,7 @@ def __init__(self, frame, buf=None, columns=None, col_space=None,
                  justify=None, float_format=None, sparsify=None,
                  index_names=True, line_width=None, max_rows=None,
                  max_cols=None, show_dimensions=False, decimal='.',
-                 table_id=None, **kwds):
+                 table_id=None, render_links=False, **kwds):
         self.frame = frame
         if buf is not None:
             self.buf = _expand_user(_stringify_path(buf))
@@ -410,6 +410,7 @@ def __init__(self, frame, buf=None, columns=None, col_space=None,
                                       len(self.frame))
         self.show_dimensions = show_dimensions
         self.table_id = table_id
+        self.render_links = render_links
 
         if justify is None:
             self.justify = get_option("display.colheader_justify")
@@ -735,7 +736,8 @@ def to_html(self, classes=None, notebook=False, border=None):
                                       max_cols=self.max_cols,
                                       notebook=notebook,
                                       border=border,
-                                      table_id=self.table_id)
+                                      table_id=self.table_id,
+                                      render_links=self.render_links)
         if hasattr(self.buf, 'write'):
             html_renderer.write_result(self.buf)
         elif isinstance(self.buf, compat.string_types):

pandas/io/formats/html.py

@@ -19,14 +19,16 @@
 from pandas.io.formats.format import (
     TableFormatter, buffer_put_lines, get_level_lengths)
 from pandas.io.formats.printing import pprint_thing
+from pandas.io.common import _is_url
 
 
 class HTMLFormatter(TableFormatter):
 
     indent_delta = 2
 
     def __init__(self, formatter, classes=None, max_rows=None, max_cols=None,
-                 notebook=False, border=None, table_id=None):
+                 notebook=False, border=None, table_id=None,
+                 render_links=False):
         self.fmt = formatter
         self.classes = classes
 
@@ -46,6 +48,7 @@ def __init__(self, formatter, classes=None, max_rows=None, max_cols=None,
             border = get_option('display.html.border')
         self.border = border
         self.table_id = table_id
+        self.render_links = render_links
 
     def write(self, s, indent=0):
         rs = pprint_thing(s)
@@ -74,9 +77,20 @@ def _write_cell(self, s, kind='td', indent=0, tags=None):
                                ('>', r'>')])
         else:
             esc = {}
+
         rs = pprint_thing(s, escape_chars=esc).strip()
-        self.write(u'{start}{rs}</{kind}>'
-                   .format(start=start_tag, rs=rs, kind=kind), indent)
+
+        if self.render_links and _is_url(rs):
+            rs_unescaped = pprint_thing(s, escape_chars={}).strip()
+            start_tag += '<a href="{url}" target="_blank">'\
+                .format(url=rs_unescaped)
+            end_a = '</a>'
+        else:
+            end_a = ''
+
+        self.write('{start}{rs}{end_a}</{kind}>'
+                   .format(start=start_tag, rs=rs, end_a=end_a, kind=kind),
+                   indent)
 
     def write_tr(self, line, indent=0, indent_delta=0, header=False,
                  align=None, tags=None, nindex_levels=0):

pandas/tests/io/formats/test_to_html.py

@@ -477,3 +477,57 @@ def test_to_html_float_format_no_fixed_width(self, datapath):
         df = DataFrame({'x': [100.0]})
         expected = expected_html(datapath, 'gh22270_expected_output')
         assert df.to_html(float_format='%.0f') == expected
+
+    @pytest.mark.parametrize("render_links", [True, False])
+    def test_to_html_render_links(self, render_links):
+        # GH 2679
+
+        data = [
+            {
+                'foo': 0,
+                'bar': 'http://pandas.pydata.org/?q1=a&q2=b',
+                None: 'pydata.org',
+            },
+            {
+                'foo': 0,
+                'bar': 'www.pydata.org',
+                None: 'pydata.org',
+            },
+        ]
+        df = DataFrame(data, columns=['foo', 'bar', None],
+                       index=range(len(data)))
+
+        result = df.to_html(render_links=render_links)
+
+        open_tag = not render_links and '<td>' or\
+            ('<td><a href="http://pandas.pydata.org/?q1=a&q2=b"'
+             ' target="_blank">')
+        close_tag = not render_links and '</td>' or '</a></td>'
+
+        expected = dedent("""\
+        <table border="1" class="dataframe">
+          <thead>
+            <tr style="text-align: right;">
+              <th></th>
+              <th>foo</th>
+              <th>bar</th>
+              <th>None</th>
+            </tr>
+          </thead>
+          <tbody>
+            <tr>
+              <th>0</th>
+              <td>0</td>
+              {open_tag}http://pandas.pydata.org/?q1=a&amp;q2=b{close_tag}
+              <td>pydata.org</td>
+            </tr>
+            <tr>
+              <th>1</th>
+              <td>0</td>
+              <td>www.pydata.org</td>
+              <td>pydata.org</td>
+            </tr>
+          </tbody>
+        </table>""").format(open_tag=open_tag, close_tag=close_tag)
+
+        assert result == expected