Changes based on PR feedback

- urls_as_links -> render_links
- Remove global default for render_links
- Add 'target="_blank"' to links in generated HTML
- Remove unicode string
- Parameterize render_links test
- Add versionadded tag to render_links on DataFrame

Author: benjaminarjun

pandas/core/config_init.py

@@ -215,13 +215,6 @@ def use_numexpr_cb(key):
     (default: True)
 """
 
-pc_html_urls_as_links_doc = """\
-: boolean
-    When True, DataFrame's to_html() will output cells that appear to contain
-    a URL with a link to that URL.
-    (default: False)
-"""
-
 pc_width_doc = """
 : int
     Width of the display in characters. In case python/IPython is running in
@@ -378,8 +371,6 @@ def table_schema_cb(key):
                        validator=is_int)
     cf.register_option('html.use_mathjax', True, pc_html_use_mathjax_doc,
                        validator=is_bool)
-    cf.register_option('html.urls_as_links', False, pc_html_urls_as_links_doc,
-                       validator=is_bool)
 
 with cf.config_prefix('html'):
     cf.register_option('border', 1, pc_html_border_doc,

pandas/core/frame.py

@@ -2086,7 +2086,7 @@ def to_html(self, buf=None, columns=None, col_space=None, header=True,
                 sparsify=None, index_names=True, justify=None, bold_rows=True,
                 classes=None, escape=True, max_rows=None, max_cols=None,
                 show_dimensions=False, notebook=False, decimal='.',
-                border=None, table_id=None, urls_as_links=None):
+                border=None, table_id=None, render_links=False):
         """
         Render a DataFrame as an HTML table.
 
@@ -2115,9 +2115,11 @@ def to_html(self, buf=None, columns=None, col_space=None, header=True,
 
             .. versionadded:: 0.23.0
 
-        urls_as_links : boolean, default False
+        render_links : boolean, default False
             Convert URLs to HTML links
 
+            .. versionadded:: 0.24.0
+
         %(returns)s
 
         See Also
@@ -2129,9 +2131,6 @@ def to_html(self, buf=None, columns=None, col_space=None, header=True,
                 justify not in fmt._VALID_JUSTIFY_PARAMETERS):
             raise ValueError("Invalid value for justify parameter")
 
-        if urls_as_links is None:
-            urls_as_links = get_option("display.html.urls_as_links")
-
         formatter = fmt.DataFrameFormatter(self, buf=buf, columns=columns,
                                            col_space=col_space, na_rep=na_rep,
                                            formatters=formatters,
@@ -2144,7 +2143,7 @@ def to_html(self, buf=None, columns=None, col_space=None, header=True,
                                            max_cols=max_cols,
                                            show_dimensions=show_dimensions,
                                            decimal=decimal, table_id=table_id,
-                                           urls_as_links=urls_as_links)
+                                           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

@@ -381,7 +381,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, urls_as_links=False, **kwds):
+                 table_id=None, render_links=False, **kwds):
         self.frame = frame
         if buf is not None:
             self.buf = _expand_user(_stringify_path(buf))
@@ -408,7 +408,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.urls_as_links = urls_as_links
+        self.render_links = render_links
 
         if justify is None:
             self.justify = get_option("display.colheader_justify")
@@ -735,7 +735,7 @@ def to_html(self, classes=None, notebook=False, border=None):
                                       notebook=notebook,
                                       border=border,
                                       table_id=self.table_id,
-                                      urls_as_links=self.urls_as_links)
+                                      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

@@ -28,7 +28,7 @@ class HTMLFormatter(TableFormatter):
 
     def __init__(self, formatter, classes=None, max_rows=None, max_cols=None,
                  notebook=False, border=None, table_id=None,
-                 urls_as_links=False):
+                 render_links=False):
         self.fmt = formatter
         self.classes = classes
 
@@ -48,7 +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.urls_as_links = urls_as_links
+        self.render_links = render_links
 
     def write(self, s, indent=0):
         rs = pprint_thing(s)
@@ -80,14 +80,15 @@ def _write_cell(self, s, kind='td', indent=0, tags=None):
 
         rs = pprint_thing(s, escape_chars=esc).strip()
 
-        if self.urls_as_links and _is_url(rs):
+        if self.render_links and _is_url(rs):
             rs_unescaped = pprint_thing(s, escape_chars={}).strip()
-            start_tag += '<a href="{url}">'.format(url=rs_unescaped)
+            start_tag += '<a href="{url}" target="_blank">'\
+                .format(url=rs_unescaped)
             end_a = '</a>'
         else:
             end_a = ''
 
-        self.write(u'{start}{rs}{end_a}</{kind}>'
+        self.write('{start}{rs}{end_a}</{kind}>'
                    .format(start=start_tag, rs=rs, end_a=end_a, kind=kind),
                    indent)
 

pandas/tests/io/formats/test_to_html.py

@@ -1909,15 +1909,11 @@ def test_to_html_with_id(self):
         result = df.to_html(index_names=False, table_id="TEST_ID")
         assert ' id="TEST_ID"' in result
 
-    def test_to_html_urls_as_links(self):
+    @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/',
-                None: 'pydata.org',
-            },
             {
                 'foo': 0,
                 'bar': 'http://pandas.pydata.org/?q1=a&q2=b',
@@ -1931,76 +1927,38 @@ def test_to_html_urls_as_links(self):
         ]
         df = DataFrame(data, columns=['foo', 'bar', None],
                        index=range(len(data)))
-        result_no_links = df.to_html()
-        result_with_links = df.to_html(urls_as_links=True)
-        expected_no_links = """\
-<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>
-      <td>http://pandas.pydata.org/</td>
-      <td>pydata.org</td>
-    </tr>
-    <tr>
-      <th>1</th>
-      <td>0</td>
-      <td>http://pandas.pydata.org/?q1=a&amp;q2=b</td>
-      <td>pydata.org</td>
-    </tr>
-    <tr>
-      <th>2</th>
-      <td>0</td>
-      <td>www.pydata.org</td>
-      <td>pydata.org</td>
-    </tr>
-  </tbody>
-</table>"""
-        expected_with_links = """\
-<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>
-      <td><a href="http://pandas.pydata.org/">http://pandas.pydata.org/</a></td>
-      <td>pydata.org</td>
-    </tr>
-    <tr>
-      <th>1</th>
-      <td>0</td>
-      <td><a href="http://pandas.pydata.org/?q1=a&q2=b">http://pandas.pydata.org/?q1=a&amp;q2=b</a></td>
-      <td>pydata.org</td>
-    </tr>
-    <tr>
-      <th>2</th>
-      <td>0</td>
-      <td>www.pydata.org</td>
-      <td>pydata.org</td>
-    </tr>
-  </tbody>
-</table>"""
 
-        assert result_with_links == expected_with_links
-        assert result_no_links == expected_no_links
+        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>'
 
-        pd.options.display.html.urls_as_links = True
-        result_no_option_specified = df.to_html()
-        pd.options.display.html.urls_as_links = False
+        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_no_option_specified == expected_with_links
+        assert result == expected