matplotlib · timhoffm · Oct 29, 2024 · Sep 17, 2024 · Sep 18, 2024 · Sep 18, 2024
diff --git a/doc/users/next_whats_new/pass_pandasDataFrame_into_table.rst b/doc/users/next_whats_new/pass_pandasDataFrame_into_table.rst
@@ -0,0 +1,21 @@
+``ax.table`` will accept a pandas dataframe
+--------------------------------------------
+
+The `~Axes.axes.table` method can now accept a data frame for the ``cellText`` method, which
+it attempts to render with column headers set by ``df.columns.to_numpy()`` and cell data set by ``df.to_numpy()``.
+
+.. code-block:: python
+
+    import matplotlib.pyplot as plt
+    import pandas as pd
+
+    data = {
+        'Letter': ['A', 'B', 'C'],
+        'Number': [100, 200, 300]
+    }
+
+    df = pd.DataFrame(data)
+    fig, ax = plt.subplots()
+    table = ax.table(df, loc='center')  # or table = ax.table(cellText=df, loc='center')
+    ax.axis('off')
+    plt.show()
diff --git a/lib/matplotlib/cbook.py b/lib/matplotlib/cbook.py
@@ -2444,3 +2444,15 @@
        return fmt % (value,)
    except (TypeError, ValueError):
        return fmt.format(value)
+
+
+def _is_pandas_dataframe(x):
+    """Check if 'x' is a Pandas DataFrame."""
+    try:
+        # we're intentionally not attempting to import Pandas. If somebody
+        # has created a Pandas DataFrame, Pandas should already be in sys.modules
+        return isinstance(x, sys.modules['pandas'].DataFrame)
+    except Exception:  # TypeError, KeyError, AttributeError, maybe others?
+        # we're attempting to access attributes on imported modules which
+        # may have arbitrary user code, so we deliberately catch all exceptions
+        return False
diff --git a/lib/matplotlib/table.py b/lib/matplotlib/table.py
@@ -33,6 +33,8 @@
 from .transforms import Bbox
 from .path import Path

+from .cbook import _is_pandas_dataframe
+

 class Cell(Rectangle):
    """
@@ -674,7 +676,7 @@ def table(ax,

    Parameters
    ----------
-    cellText : 2D list of str, optional
+    cellText : 2D list of str or pandas.DataFrame, optional
        The texts to place into the table cells.

        *Note*: Line breaks in the strings are currently not accounted for and
@@ -744,6 +746,13 @@ def table(ax,
        cols = len(cellColours[0])
        cellText = [[''] * cols] * rows

+    # Check if we have a Pandas DataFrame
+    if _is_pandas_dataframe(cellText):
+        # Convert to numpy array
+        header = cellText.columns.to_numpy()
+        data = cellText.to_numpy()
+        cellText = np.vstack([header, data])
+
    rows = len(cellText)
    cols = len(cellText[0])
    for row in cellText:

diff --git a/lib/matplotlib/table.pyi b/lib/matplotlib/table.pyi
@@ -8,7 +8,12 @@ from .transforms import Bbox
 from .typing import ColorType

 from collections.abc import Sequence
-from typing import Any, Literal
+from typing import Any, Literal, TYPE_CHECKING
+
+if TYPE_CHECKING:
+    from pandas import DataFrame
+else:
+    DataFrame = None

 class Cell(Rectangle):
    PAD: float
@@ -68,7 +73,7 @@ class Table(Artist):

 def table(
    ax: Axes,
-    cellText: Sequence[Sequence[str]] | None = ...,
+    cellText: Sequence[Sequence[str]] | DataFrame | None = ...,
    cellColours: Sequence[Sequence[ColorType]] | None = ...,
    cellLoc: Literal["left", "center", "right"] = ...,
    colWidths: Sequence[float] | None = ...,

diff --git a/lib/matplotlib/tests/test_table.py b/lib/matplotlib/tests/test_table.py
@@ -264,3 +264,25 @@ def __repr__(self):

    munits.registry.pop(FakeUnit)
    assert not munits.registry.get_converter(FakeUnit)
+
+
+def test_table_dataframe(pd):
+    # Test if Pandas Data Frame can be passed in cellText
+
+    data = {
+        'Letter': ['A', 'B', 'C'],
+        'Number': [100, 200, 300]
+    }
+
+    df = pd.DataFrame(data)
+    fig, ax = plt.subplots()
+    table = ax.table(df, loc='center')
+
+    assert table[0, 0].get_text().get_text() == 'Letter'
+    assert table[0, 1].get_text().get_text() == 'Number'
+    assert table[1, 0].get_text().get_text() == 'A'
+    assert table[1, 1].get_text().get_text() == str(100)
+    assert table[2, 0].get_text().get_text() == 'B'
+    assert table[2, 1].get_text().get_text() == str(200)
+    assert table[3, 0].get_text().get_text() == 'C'
+    assert table[3, 1].get_text().get_text() == str(300)
-Original file line number
+Diff line change
@@ -33,6 +33,8 @@
     from .transforms import Bbox
     from .path import Path
+    from .cbook import _is_pandas_dataframe
     class Cell(Rectangle):
         """
@@ -674,7 +676,7 @@ def table(ax,
         Parameters
         ----------
-        cellText : 2D list of str, optional
+        cellText : 2D list of str or pandas.DataFrame, optional
             The texts to place into the table cells.
             *Note*: Line breaks in the strings are currently not accounted for and
@@ -744,6 +746,13 @@ def table(ax,
             cols = len(cellColours[0])
             cellText = [[''] * cols] * rows
+        # Check if we have a Pandas DataFrame
+        if _is_pandas_dataframe(cellText):
             Copy link

  
      
    
  

  
      

  
  Member


      

  

  
    
      

      
            jklymak
  

      

      

      


        Sep 23, 2024


      
    

  


        
      
  
  
  
    

    There was a problem hiding this comment.


  

 
  
    

    Choose a reason for hiding this comment

    
      The reason will be displayed to describe this comment to others. Learn more.
    

    
      
      


  


  
    
      I'd actually make this more generic, and check if cellText has a columns attribute and a to_numpy method.  That lets non-pandas objects also work; for instance polars is a pandas competitor, and there is no reason its dataframes could not be passed in here: https://docs.pola.rs/api/python/stable/reference/dataframe/api/polars.DataFrame.columns.html

https://docs.pola.rs/api/python/stable/reference/dataframe/api/polars.DataFrame.to_numpy.html
    
  
  


    

        
      
  
  
    
  
  
  
    
    Sorry, something went wrong.
  

  
    
  
    
      

              Uh oh!

              
There was an error while loading. Please reload this page.


  
  


          
      
  
    
    
      
        
            
    All reactions
  


          
          
        
      
    

    



  
        
  
    
        
    
  


      
          
  
      
            Copy link

  
      
    
  

  
      

  
  Member


      

  

  
    
      

      
            timhoffm
  

      

      

      


        Sep 24, 2024


      
  •

  
    
      
        
          edited
          
        
        
      
    
    
      
  
        
      Loading


  
    
  
    
      

              Uh oh!

              
There was an error while loading. Please reload this page.


  
  
    
  


    

  


        
      
  
  
  
    

    There was a problem hiding this comment.


  

 
  
    

    Choose a reason for hiding this comment

    
      The reason will be displayed to describe this comment to others. Learn more.
    

    
      
      


  


  
    
      Note that polars.DataFrame.columns is of type list[str], so the current implementation using cellText.columns.to_numpy() would fail. These are exactly the subtleties I did not want to go into as part of this first-time contributor PR. Let's start with pandas, which is a clean addition. We can always generalize later, which should likely conform to the dataframe API standard (note that this is still draft)
As a side-remark: The table implementation has lots of design problems. If one was serious about tables, the whole Table would need to be rewritten/replaced. Therefore, I wouldn't spend too much effort on trying to improve implementation.
    
  
  


    

        
      
  
  
    
  
  
  
    
    Sorry, something went wrong.
  

  
    
  
    
      

              Uh oh!

              
There was an error while loading. Please reload this page.


  
  


          
      
  
    
    
      
        
            
    All reactions
+            # Convert to numpy array
+            header = cellText.columns.to_numpy()
+            data = cellText.to_numpy()
+            cellText = np.vstack([header, data])
         rows = len(cellText)
         cols = len(cellText[0])
         for row in cellText:
-          Expand Down