feat: support column_width in xlsx format #516

Birdi7 · 2022-02-17T10:20:31Z

This PR allows user to specify column width in XLXS format. For it has a default value, which is not suitable for long values in dataset. As a result, it is not convenient to look these tables. Also, it eliminates questions like #318 in future

I didn't find tests for exporting, so omitted this. Let me know if they are required

codecov · 2022-02-17T10:22:05Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 91.11%. Comparing base (de1a47a) to head (0f7e2ef).
Report is 59 commits behind head on master.

Additional details and impacted files

@@            Coverage Diff             @@
##           master     #516      +/-   ##
==========================================
+ Coverage   90.84%   91.11%   +0.27%     
==========================================
  Files          28       28              
  Lines        2664     2702      +38     
==========================================
+ Hits         2420     2462      +42     
+ Misses        244      240       -4

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Birdi7 · 2022-03-31T13:04:10Z

Hello @hugovk! Sorry for ping, but I just want to ask if you have any time for review and merge this?

hugovk

Thanks for the ping! Please could you add some tests that use the different possible values?

docs/formats.rst

Birdi7 · 2022-04-01T11:59:55Z

@hugovk Thank you for the review! I've added the test on check the new feature, checkout test_xlsx_column_width. Would you mind review the PR, and if everything is ok merge it to master?

hugovk

Some general comments. And please could we have three separate test cases that call export_set with different values for column_width: None, an integer and "adaptive".

That way we see each branch of your code is running without error, and it will be reflected in the coverage.

AUTHORS

docs/formats.rst

src/tablib/formats/_xlsx.py

Birdi7 · 2022-04-01T12:52:34Z

Thank you for such usefull comment! I've found a bug with new tests. Your comments are pushed, alongside with all three tests. What do you think on it?

tests/test_tablib.py

Birdi7 · 2022-06-08T11:35:21Z

Thank you for your comment! I believe this significantly improves redability. Could please take a look if the PR is fine now?

src/tablib/formats/_xlsx.py

hugovk

Thank you! A couple of minor suggestions.

docs/formats.rst

src/tablib/formats/_xlsx.py

rakinson · 2024-08-22T12:58:07Z

Hi there, I would find this enhancement useful. Do you mind to take this last step to add this feature?
Thank you!

Birdi7 · 2024-10-08T19:42:32Z

Hi! I won't be able to finish this PR, so feel free to do that!

andrewgy8 · 2025-01-17T09:34:16Z

Hey! We think it would be useful over at Django-Import-Export!

I dont mind picking up this PR (rebasing, docs updates, and your comments @hugovk ) if we think it can be merged in.

Given the work put in already by you all, it would be a shame to leave it abandoned. Thanks!

claudep · 2025-01-17T10:01:40Z

Sure, feel free to take and polish this PR!

Co-authored-by: Hugo van Kemenade <[email protected]>

andrewgy8 · 2025-01-18T07:32:49Z

Okie dokie! I have:

updated the code with comments from @hugovk ✅
rebased on master ✅
cleaned up the tests a bit ✅
and cleaned up the column width code a bit ✅

Let me know if there is anything else I can do to get this across the line! Thanks for the help!

And sorry for all the force pushes, github didnt like that I was rebasing all the changes of a branch of a fork I dont own 🤷

claudep

Thanks for refreshing this PR! You may also add an entry in HISTORY.md.

docs/formats.rst

src/tablib/formats/_xlsx.py

claudep · 2025-01-18T14:40:32Z

src/tablib/formats/_xlsx.py

+        If ``column_width`` is set to "adaptive", the column width will be set to the maximum
+        width of the content in each column. If it is set to an integer, the column width will be
+        set to that integer value. If it is set to None, the column width will be set as the
+        default openpyxl.Worksheet width value.


What do you think about accepting a list of column widths to be able to set widths per column? It may also be a follow-up improvement PR.

Yeah, I think that would be a valid iteration on this change 👍

andrewgy8 · 2025-01-19T06:26:22Z

Updated @claudep ! Thanks for the quick review!

claudep · 2025-01-19T19:50:47Z

Thanks, let's wait now for @hugovk to make a final review.

docs/formats.rst

src/tablib/formats/_xlsx.py

Co-authored-by: Hugo van Kemenade <[email protected]>

for more information, see https://pre-commit.ci

Co-authored-by: Hugo van Kemenade <[email protected]>

hugovk

Thanks!

andrewgy8 · 2025-01-21T03:26:51Z

Thanks all! Looking forward to adding this to Django Import Export!

Birdi7 mentioned this pull request Feb 17, 2022

feat: adaptive column width django-import-export/django-import-export#1394

Closed

Birdi7 changed the title ~~feat: support column_width in xlxs format~~ feat: support column_width in xlsx format Mar 31, 2022

hugovk requested changes Mar 31, 2022

View reviewed changes

docs/formats.rst Outdated Show resolved Hide resolved

hugovk mentioned this pull request Apr 1, 2022

Support Mac OS LF char for csv #517

Closed

hugovk requested changes Apr 1, 2022

View reviewed changes

AUTHORS Outdated Show resolved Hide resolved

docs/formats.rst Outdated Show resolved Hide resolved

docs/formats.rst Outdated Show resolved Hide resolved

src/tablib/formats/_xlsx.py Outdated Show resolved Hide resolved

src/tablib/formats/_xlsx.py Outdated Show resolved Hide resolved

hugovk reviewed Apr 1, 2022

View reviewed changes

tests/test_tablib.py Outdated Show resolved Hide resolved

hugovk reviewed Jun 8, 2022

View reviewed changes

src/tablib/formats/_xlsx.py Outdated Show resolved Hide resolved

hugovk requested changes Dec 21, 2022

View reviewed changes

docs/formats.rst Outdated Show resolved Hide resolved

src/tablib/formats/_xlsx.py Outdated Show resolved Hide resolved

rakinson approved these changes Aug 22, 2024

View reviewed changes

mglowinski93 mentioned this pull request Oct 18, 2024

How to add a header row to excel django-import-export/django-import-export#1970

Closed

andrewgy8 mentioned this pull request Jan 17, 2025

feat: Support formatting for Excel exports django-import-export/django-import-export#2025

Open

Birdi7 and others added 10 commits January 18, 2025 14:26

feat: support column_width in xlxs format

80ab473

Update docs/formats.rst

7a903b6

Co-authored-by: Hugo van Kemenade <[email protected]>

chore: add tests for adaptive column width in xlsx format

7fbbd9d

chore: change assert style

c1196d6

Update src/tablib/formats/_xlsx.py

6811201

Co-authored-by: Hugo van Kemenade <[email protected]>

Update src/tablib/formats/_xlsx.py

19c0c58

Co-authored-by: Hugo van Kemenade <[email protected]>

chore: alphabetical order in AUTHORS

f6a9664

chore: docs

d42f313

chore: add tests and fix bug

618930a

refactor: helper function for tests and new test case for error

7bfafaa

Co-authored-by: Hugo van Kemenade <[email protected]>

Birdi7 and others added 2 commits January 18, 2025 14:31

chore: use from __future__ import annotations

eeca7e5

Update tests and code for easier reading

be9db5e

andrewgy8 force-pushed the master branch from 0f7e2ef to be9db5e Compare January 18, 2025 07:13

Update format doc for clarity

af35169

andrewgy8 force-pushed the master branch from e4b6cb0 to af35169 Compare January 18, 2025 07:17

Update message format for exception raised

c3fcf8d

andrewgy8 force-pushed the master branch from 626f53b to c3fcf8d Compare January 18, 2025 07:19

Linting and formatting

c29c9dd

andrewgy8 force-pushed the master branch from b799a13 to c29c9dd Compare January 18, 2025 07:28

claudep reviewed Jan 18, 2025

View reviewed changes

andrewgy8 added 3 commits January 19, 2025 14:19

Linting and formatting

fd73a96

Add history entry

6d1a7fa

Fix history versioning

3bed224

hugovk reviewed Jan 19, 2025

View reviewed changes

docs/formats.rst Outdated Show resolved Hide resolved

src/tablib/formats/_xlsx.py Outdated Show resolved Hide resolved

andrewgy8 and others added 3 commits January 20, 2025 08:03

Update docs/formats.rst

dc68dfa

Co-authored-by: Hugo van Kemenade <[email protected]>

[pre-commit.ci] auto fixes from pre-commit.com hooks

f4277f3

for more information, see https://pre-commit.ci

Update src/tablib/formats/_xlsx.py

2999501

Co-authored-by: Hugo van Kemenade <[email protected]>

hugovk approved these changes Jan 20, 2025

View reviewed changes

claudep merged commit b783693 into jazzband:master Jan 20, 2025
19 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: support column_width in xlsx format #516

feat: support column_width in xlsx format #516

Birdi7 commented Feb 17, 2022 •

edited

Loading

codecov bot commented Feb 17, 2022 •

edited

Loading

Birdi7 commented Mar 31, 2022

hugovk left a comment

Birdi7 commented Apr 1, 2022 •

edited

Loading

hugovk left a comment

Birdi7 commented Apr 1, 2022

Birdi7 commented Jun 8, 2022

hugovk left a comment

rakinson commented Aug 22, 2024

Birdi7 commented Oct 8, 2024

andrewgy8 commented Jan 17, 2025

claudep commented Jan 17, 2025

andrewgy8 commented Jan 18, 2025 •

edited

Loading

claudep left a comment

claudep Jan 18, 2025

andrewgy8 Jan 19, 2025

andrewgy8 commented Jan 19, 2025

claudep commented Jan 19, 2025

hugovk left a comment

andrewgy8 commented Jan 21, 2025

feat: support column_width in xlsx format #516

feat: support column_width in xlsx format #516

Conversation

Birdi7 commented Feb 17, 2022 • edited Loading

codecov bot commented Feb 17, 2022 • edited Loading

Codecov Report

Birdi7 commented Mar 31, 2022

hugovk left a comment

Choose a reason for hiding this comment

Birdi7 commented Apr 1, 2022 • edited Loading

hugovk left a comment

Choose a reason for hiding this comment

Birdi7 commented Apr 1, 2022

Birdi7 commented Jun 8, 2022

hugovk left a comment

Choose a reason for hiding this comment

rakinson commented Aug 22, 2024

Birdi7 commented Oct 8, 2024

andrewgy8 commented Jan 17, 2025

claudep commented Jan 17, 2025

andrewgy8 commented Jan 18, 2025 • edited Loading

claudep left a comment

Choose a reason for hiding this comment

claudep Jan 18, 2025

Choose a reason for hiding this comment

andrewgy8 Jan 19, 2025

Choose a reason for hiding this comment

andrewgy8 commented Jan 19, 2025

claudep commented Jan 19, 2025

hugovk left a comment

Choose a reason for hiding this comment

andrewgy8 commented Jan 21, 2025

Birdi7 commented Feb 17, 2022 •

edited

Loading

codecov bot commented Feb 17, 2022 •

edited

Loading

Birdi7 commented Apr 1, 2022 •

edited

Loading

andrewgy8 commented Jan 18, 2025 •

edited

Loading