openpyxl: no attribute "column_dimensions" #11706

Activity

1. srittau

   added

   priority: regressionSomething that worked before doesn't work anymoreSomething that worked before doesn't work anymore

   on Apr 2, 2024
2. srittau commented on Apr 2, 2024

   

   srittau

   on Apr 2, 2024

   Collaborator

   More actions

   Cc @Avasam
3. Avasam commented on Apr 2, 2024

   

   Avasam

   on Apr 2, 2024

   Last edited by Avasam

   SponsorCollaborator

   More actions

   The issue here is raised by not knowing statically whether your workbook is read_only, write_only, or "regular", and whether it contains Chartsheets or not. Only WorkSheet contains column_dimensions. Chartsheet, WriteOnlyWorksheet, ReadOnlyWorksheet all don't.

   Related to #9940 , where a generic workbook would help with knowing whether worksheets, and cells, are write_only or read_only, but that still wouldn't help with Chartsheet, maybe we could fudge around that one for __getitem__ as a common use-case.
   Another thing I need to validate, is whether a regular workbook could have read_only or write_only worksheets. It's "possible" code-wise, just not sure if it's an edge case that should/could happen with actual workbooks.

   With the last stub update, you can do:

   import openpyxl
   from openpyxl.worksheet.worksheet import Worksheet
   
   workbook = openpyxl.open(filename)
   sheet = workbook [worksheet_name]
   assert isinstance(sheet, Worksheet)  # sheet is a Worksheet
   sheet.column_dimensions

   or

   import openpyxl
   from openpyxl.worksheet.worksheet import Worksheet
   
   workbook = openpyxl.open(filename)
   sheet = workbook[worksheet_name]
   if isinstance(sheet, Worksheet):  # sheet is a Worksheet
       sheet.column_dimensions

   This is yet another case for python/typing#566

   That being said, with #9940 being an open issue with a potential better long-term solution (with the fudging of Chartsheet I have mentioned), I wouldn't mind changing the returns to Any (complex return type) short term. Or even back to Worksheet, whilst "incorrect and incomplete", getting Worksheet is the most common use case (and I'd just have to focus on completing #9940 :P )
4. jimmyppi commented on Apr 3, 2024

   

   jimmyppi

   on Apr 3, 2024

   Author

   More actions

   Thanks @Avasam, I'll use one of the workarounds for now
5. srittau

   closed this as completedin #11718on Apr 27, 2024