feat: support column_width in xlsx format

AUTHORS

@@ -32,3 +32,4 @@ Here is a list of passed and present much-appreciated contributors:
     Tommy Anthony
     Tsuyoshi Hombashi
     Tushar Makkar
+    Egor Osokin

docs/formats.rst

@@ -234,6 +234,20 @@ The ``import_set()`` method also supports a ``skip_lines`` parameter that you
 can set to a number of lines that should be skipped before starting to read
 data.
 
+The ``export_set()`` method supports a ``column_width`` parameter. Depending on the
+value you pass, the column width will be set accordingly. It can be either None, int, or "adaptive".
+If "adaptive" is passed, the column width will be unique for every column and will be 
+calculated based on values' length. Example of usage
+
+```python3
+data = tablib.Dataset()
+data.export('xlsx', column_width='adaptive')
+```
+
+
+.. versionchanged:: 3.3.0
+    The ``column_width`` parameter for ``export_set()`` was added.
+
 .. versionchanged:: 3.1.0
 
     The ``skip_lines`` parameter for ``import_set()`` was added.

src/tablib/formats/_xlsx.py

@@ -3,6 +3,7 @@
 
 import re
 from io import BytesIO
+from typing import Optional, Union
 
 from openpyxl.reader.excel import ExcelReader, load_workbook
 from openpyxl.styles import Alignment, Font
@@ -35,12 +36,17 @@ def detect(cls, stream):
             return False
 
     @classmethod
-    def export_set(cls, dataset, freeze_panes=True, invalid_char_subst="-"):
+    def export_set(
+        cls, dataset, freeze_panes=True, invalid_char_subst="-",
+        column_width: Optional[Union[str, int]] = "adaptive"
+    ):
         """Returns XLSX representation of Dataset.
 
         If dataset.title contains characters which are considered invalid for an XLSX file
         sheet name (http://www.excelcodex.com/2012/06/worksheets-naming-conventions/), they will
         be replaced with `invalid_char_subst`.
+
+        column_width: can have int, None, or "adaptive" as a value
         """
         wb = Workbook()
         ws = wb.worksheets[0]
@@ -51,6 +57,11 @@ def export_set(cls, dataset, freeze_panes=True, invalid_char_subst="-"):
         )
 
         cls.dset_sheet(dataset, ws, freeze_panes=freeze_panes)
+        if isinstance(column_width, str) and column_width != "adaptive":
+            raise ValueError(f"Unsupported value `{column_width}` passed to `column_width` "
+                             f"parameter. It supports 'adaptive' or integer values")
+
+        cls._adapt_column_width(ws, column_width)
 
         stream = BytesIO()
         wb.save(stream)
@@ -166,3 +177,25 @@ def dset_sheet(cls, dataset, ws, freeze_panes=True):
                     cell.value = col
                 except (ValueError, TypeError):
                     cell.value = str(col)
+
+    @classmethod
+    def _adapt_column_width(cls, worksheet,
+                            width: Optional[Union[str, int]]) -> None:
+        if width is None:
+            return
+
+        column_widths = []
+        if isinstance(width, str) and width == "adaptive":
+            for row in worksheet.values:
+                for i, cell in enumerate(row):
+                    cell = str(cell)
+                    if len(column_widths) > i:
+                        if len(cell) > column_widths[i]:
+                            column_widths[i] = len(cell)
+                    else:
+                        column_widths += [len(cell)]
+        else:
+            column_widths = [width] * len(worksheet.values)
+
+        for i, column_width in enumerate(column_widths, 1): # start at 1
+            worksheet.column_dimensions[get_column_letter(i)].width = column_width

tests/test_tablib.py

@@ -9,9 +9,11 @@
 from collections import OrderedDict
 from io import BytesIO, StringIO
 from pathlib import Path
+from tempfile import TemporaryFile
 from uuid import uuid4
 
 from MarkupPy import markup
+from openpyxl import load_workbook
 
 import tablib
 from tablib.core import Row, detect_format
@@ -1100,7 +1102,25 @@ def test_xlsx_bad_dimensions(self):
             data = tablib.Dataset().load(fh, read_only=False)
         self.assertEqual(data.height, 3)
 
+    def test_xlsx_column_width(self):
+        """check that column width adapts to value length"""
+        def _get_width(data):
+            xlsx_content = data.export('xlsx')
+            wb = load_workbook(filename=BytesIO(xlsx_content))
+            ws = wb.active
+            return ws.column_dimensions['A'].width
 
+        xls_source = Path(__file__).parent / 'files' / 'xlsx_cell_values.xlsx'
+        with xls_source.open('rb') as fh:
+            data = tablib.Dataset().load(fh)
+        width_before = _get_width(data)
+        data.append([
+            'verylongvalue-verylongvalue-verylongvalue-verylongvalue-verylongvalue-verylongvalue-verylongvalue-verylongvalue',
+        ])
+        width_after = _get_width(data)
+
+        self.assertNotEqual(width_before, width_after)
+
 class JSONTests(BaseTestCase):
     def test_json_format_detect(self):
         """Test JSON format detection."""