[FIX] report_xlsx: sanitize worksheet name to prevent InvalidWorksheetName - #1194
Open
stephansainleger wants to merge 1 commit into
Open
[FIX] report_xlsx: sanitize worksheet name to prevent InvalidWorksheetName#1194stephansainleger wants to merge 1 commit into
stephansainleger wants to merge 1 commit into
Conversation
…tName Excel worksheet names are limited to 31 characters, cannot contain []:*?/\ and cannot start or end with an apostrophe. Report names do not guarantee these constraints, so xlsxwriter can raise InvalidWorksheetName (e.g. when a report name ends with an apostrophe once truncated to 31 chars). Sanitize the sheet name in PatchedXlsxWorkbook._check_sheetname before the library validation and the duplicate handling, so a normalized name never triggers the error again. Add a test covering forbidden characters, leading/trailing apostrophes and length truncation.
Author
|
I'd like to request feedback from the community on this PR. I'm proposing it following a bug I encountered with one of my clients, where the company name resulted in an apostrophe landing exactly at the end of the sheet name. The goal is to avoid breaking the worksheet creation process. I also took the opportunity to clean up names more broadly, so that undesirable characters get sanitized as well. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Excel worksheet names are limited to 31 characters, cannot contain []:*?/\ and cannot start or end with an apostrophe. Report names do not guarantee these constraints, so xlsxwriter can raise InvalidWorksheetName (e.g. when a report name ends with an apostrophe once truncated to 31 chars).
Sanitize the sheet name in PatchedXlsxWorkbook._check_sheetname before the library validation and the duplicate handling, so a normalized name never triggers the error again. Add a test covering forbidden characters, leading/trailing apostrophes and length truncation.