Series repr html only

doc/source/whatsnew/v1.0.0.rst

@@ -113,6 +113,7 @@ Other enhancements
 - Implemented :meth:`pandas.core.window.Window.var` and :meth:`pandas.core.window.Window.std` functions (:issue:`26597`)
 - Added ``encoding`` argument to :meth:`DataFrame.to_string` for non-ascii text (:issue:`28766`)
 - Added ``encoding`` argument to :func:`DataFrame.to_html` for non-ascii text (:issue:`28663`)
+- Added :meth:`Series._repr_html_` to :class:`Series` to provide basic HTML rendering suitable for notebooks (:issue:`5563`).
 - :meth:`Styler.background_gradient` now accepts ``vmin`` and ``vmax`` arguments (:issue:`12145`)
 
 Build Changes

pandas/core/series.py

@@ -1576,6 +1576,150 @@ def __repr__(self) -> str:
 
         return result
 
+    def _repr_html_(self):
+        """
+        Return a html representation for a particular DataFrame.
+
+        Mainly for IPython notebook.
+        """
+        # TODO: Full independent HTML generation in SeriesFormatter, rather
+        # than depending on a limited subset of functionality via to_frame().
+        if get_option("display.notebook_repr_html"):
+            max_rows = get_option("display.max_rows")
+            min_rows = get_option("display.min_rows")
+            show_dimensions = get_option("display.show_dimensions")
+
+            formatter = fmt.DataFrameFormatter(
+                self.to_frame(),
+                columns=None,
+                col_space=None,
+                na_rep="NaN",
+                formatters=None,
+                float_format=None,
+                sparsify=None,
+                justify=None,
+                index_names=True,
+                header=False,
+                index=True,
+                bold_rows=True,
+                escape=True,
+                max_rows=max_rows,
+                min_rows=min_rows,
+                show_dimensions=False,  # We do this later for a series.
+                decimal=".",
+                table_id=None,
+                render_links=False,
+            )
+            html = formatter.to_html(notebook=True).split("\n")
+
+            # Find out where the column ends - we will insert footer information here.
+            tbl_end = [
+                rownum for (rownum, row) in enumerate(html) if "</table>" in row
+            ][-1]
+
+            footer = []
+            if self.name is not None:
+                footer.append("Name: <b>{name}</b>".format(name=self.name))
+            if show_dimensions:
+                footer.append("Length: {rows}".format(rows=len(self)))
+            footer.append("dtype: <tt>{dtype}</tt>".format(dtype=self.dtype))
+
+            html.insert(tbl_end + 1, "<p>{footer}</p>".format(footer=", ".join(footer)))
+
+            return "\n".join(html)
+        else:
+            return None
+
+    @Substitution(
+        header_type="bool",
+        header="Whether to print column labels, default True",
+        col_space_type="str or int",
+        col_space="The minimum width of each column in CSS length "
+        "units.  An int is assumed to be px units.\n\n"
+        "            .. versionadded:: 0.25.0\n"
+        "                Ability to use str",
+    )
+    @Substitution(shared_params=fmt.common_docstring, returns=fmt.return_docstring)
+    def to_html(
+        self,
+        buf=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,
+        show_dimensions=False,
+        decimal=".",
+        bold_rows=True,
+        classes=None,
+        escape=True,
+        notebook=False,
+        border=None,
+        series_id=None,
+        render_links=False,
+        encoding=None,
+    ):
+        """
+        Render a Series as a single-column HTML table.
+        %(shared_params)s
+        bold_rows : bool, default True
+            Make the row labels bold in the output.
+        classes : str or list or tuple, default None
+            CSS class(es) to apply to the resulting html table.
+        escape : bool, default True
+            Convert the characters <, >, and & to HTML-safe sequences.
+        notebook : {True, False}, default False
+            Whether the generated HTML is for IPython Notebook.
+        border : int
+            A ``border=border`` attribute is included in the opening
+            `<table>` tag. Default ``pd.options.display.html.border``.
+        encoding : str, default "utf-8"
+            Set character encoding
+        series_id : str, optional
+            A css id is included in the opening `<table>` tag if specified.
+        render_links : bool, default False
+            Convert URLs to HTML links.
+        %(returns)s
+        See Also
+        --------
+        to_string : Convert Series to a string.
+        """
+
+        if justify is not None and justify not in fmt._VALID_JUSTIFY_PARAMETERS:
+            raise ValueError("Invalid value for justify parameter")
+
+        formatter = fmt.SeriesFormatter(
+            self,
+            col_space=col_space,
+            na_rep=na_rep,
+            formatters=formatters,
+            float_format=float_format,
+            sparsify=sparsify,
+            justify=justify,
+            index_names=index_names,
+            header=header,
+            index=index,
+            bold_rows=bold_rows,
+            escape=escape,
+            max_rows=max_rows,
+            show_dimensions=show_dimensions,
+            decimal=decimal,
+            series_id=series_id,
+            render_links=render_links,
+        )
+        return formatter.to_html(
+            buf=buf,
+            classes=classes,
+            notebook=notebook,
+            border=border,
+            encoding=encoding,
+        )
+
     def to_string(
         self,
         buf=None,