diff --git a/doc/source/whatsnew/v0.25.0.rst b/doc/source/whatsnew/v0.25.0.rst index c441244b4415d..6488d33f11d41 100644 --- a/doc/source/whatsnew/v0.25.0.rst +++ b/doc/source/whatsnew/v0.25.0.rst @@ -361,6 +361,7 @@ I/O - Bug in ``read_csv`` which would not raise ``ValueError`` if a column index in ``usecols`` was out of bounds (:issue:`25623`) - Improved the explanation for the failure when value labels are repeated in Stata dta files and suggested work-arounds (:issue:`25772`) - Improved :meth:`pandas.read_stata` and :class:`pandas.io.stata.StataReader` to read incorrectly formatted 118 format files saved by Stata (:issue:`25960`) +- Improved the ``col_space`` parameter in :meth:`DataFrame.to_html` to accept a string so CSS length values can be set correctly (:issue:`25941`) - Fixed bug in loading objects from S3 that contain ``#`` characters in the URL (:issue:`25945`) Plotting diff --git a/pandas/core/frame.py b/pandas/core/frame.py index 13c8e97bff23f..8944ec642a7be 100644 --- a/pandas/core/frame.py +++ b/pandas/core/frame.py @@ -663,7 +663,9 @@ def _repr_html_(self): @Substitution(header='Write out the column names. If a list of strings ' 'is given, it is assumed to be aliases for the ' - 'column names') + 'column names', + col_space_type='int', + col_space='The minimum width of each column') @Substitution(shared_params=fmt.common_docstring, returns=fmt.return_docstring) def to_string(self, buf=None, columns=None, col_space=None, header=True, @@ -2149,7 +2151,12 @@ def to_parquet(self, fname, engine='auto', compression='snappy', compression=compression, index=index, partition_cols=partition_cols, **kwargs) - @Substitution(header='Whether to print column labels, default True') + @Substitution(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' + ' Abillity to use str') @Substitution(shared_params=fmt.common_docstring, returns=fmt.return_docstring) def to_html(self, buf=None, columns=None, col_space=None, header=True, diff --git a/pandas/io/formats/format.py b/pandas/io/formats/format.py index b397a370cecbf..4d7ba1540b9bf 100644 --- a/pandas/io/formats/format.py +++ b/pandas/io/formats/format.py @@ -45,8 +45,8 @@ Buffer to write to. columns : sequence, optional, default None The subset of columns to write. Writes all columns by default. - col_space : int, optional - The minimum width of each column. + col_space : %(col_space_type)s, optional + %(col_space)s. header : bool, optional %(header)s. index : bool, optional, default True diff --git a/pandas/io/formats/html.py b/pandas/io/formats/html.py index 031891cb2f7cb..d965b6f5859a0 100644 --- a/pandas/io/formats/html.py +++ b/pandas/io/formats/html.py @@ -46,6 +46,9 @@ def __init__(self, formatter, classes=None, border=None): self.border = border self.table_id = self.fmt.table_id self.render_links = self.fmt.render_links + if isinstance(self.fmt.col_space, int): + self.fmt.col_space = ('{colspace}px' + .format(colspace=self.fmt.col_space)) @property def show_row_idx_names(self): @@ -85,8 +88,30 @@ def write(self, s, indent=0): rs = pprint_thing(s) self.elements.append(' ' * indent + rs) - def write_th(self, s, indent=0, tags=None): - if self.fmt.col_space is not None and self.fmt.col_space > 0: + def write_th(self, s, header=False, indent=0, tags=None): + """ + Method for writting a formatted cell. + + If col_space is set on the formatter then that is used for + the value of min-width. + + Parameters + ---------- + s : object + The data to be written inside the cell. + header : boolean, default False + Set to True if the is for use inside . This will + cause min-width to be set if there is one. + indent : int, default 0 + The indentation level of the cell. + tags : string, default None + Tags to include in the cell. + + Returns + ------- + A written cell. + """ + if header and self.fmt.col_space is not None: tags = (tags or "") tags += ('style="min-width: {colspace};"' .format(colspace=self.fmt.col_space)) @@ -137,7 +162,7 @@ def write_tr(self, line, indent=0, indent_delta=0, header=False, for i, s in enumerate(line): val_tag = tags.get(i, None) if header or (self.bold_rows and i < nindex_levels): - self.write_th(s, indent, tags=val_tag) + self.write_th(s, indent=indent, header=header, tags=val_tag) else: self.write_td(s, indent, tags=val_tag) diff --git a/pandas/tests/io/formats/test_to_html.py b/pandas/tests/io/formats/test_to_html.py index 0acad80bbeef2..888a4af43d547 100644 --- a/pandas/tests/io/formats/test_to_html.py +++ b/pandas/tests/io/formats/test_to_html.py @@ -643,3 +643,17 @@ def test_to_html_round_column_headers(): notebook = df.to_html(notebook=True) assert "0.55555" in html assert "0.556" in notebook + + +@pytest.mark.parametrize("unit", ['100px', '10%', '5em', 150]) +def test_to_html_with_col_space_units(unit): + # GH 25941 + df = DataFrame(np.random.random(size=(1, 3))) + result = df.to_html(col_space=unit) + result = result.split('tbody')[0] + hdrs = [x for x in result.split("\n") if re.search(r"\s]", x)] + if isinstance(unit, int): + unit = str(unit) + 'px' + for h in hdrs: + expected = ''.format(unit=unit) + assert expected in h