Pandas DataFrame.to_html() accessibility limits for screen readers

Answer

DataFrame.to_html() does not provide parameters for ARIA roles, scope attributes, or a summary attribute; it only accepts a caption argument to insert a <caption> element.

Confirmed facts

• The caption argument adds a <caption> tag directly.
• No built‑in parameters exist for role, aria‑label, scope, or summary.
• The Styler API (df.style.set_caption() and set_table_attributes()) can inject arbitrary attributes, including ARIA roles and labels, and has been stable since pandas 1.0.
• Default HTML output may change between releases (e.g., addition of the dataframe class, modifications to <thead>/<tbody> structure, removal of the deprecated border attribute).

Steps to verify and improve accessibility

1. Check the raw markup:

   import pandas as pd
   df = pd.DataFrame({'A': [1, 2], 'B': [3, 4]})
   print(df.to_html())
   

   Look for <caption>, scope, role, or any aria- strings.
2. If you need ARIA roles or labels, use Styler:

   html = (
       df.style
         .set_caption('Sample table')
         .set_table_attributes('role="grid" aria-label="Sample data table"')
         .to_html()
   )
   print(html)
   

   Confirm the attributes appear in the output.
3. Check your pandas version:

   print(pd.__version__)
   

   If the version is < 1.0, the Styler API may behave differently; otherwise it is considered stable.
4. After upgrading pandas, re‑run the above snippets and compare the markup to ensure any custom CSS or JS that relies on class names or structure still works.

Missing diagnostic detail

To give a definitive recommendation on whether the Styler‑based approach is safe for your production environment, please confirm the exact pandas version you are running (e.g., 1.5.3, 2.2.0). If the version is below 1.0, the Styler API may lack the set_table_attributes method.