Rename html_formatter to dataframe_formatter

Author: timsaucer

docs/source/api/dataframe.rst

@@ -174,7 +174,7 @@ HTML Rendering Customization
 ----------------------------
 
 DataFusion provides extensive customization options for HTML table rendering through the
-``datafusion.html_formatter`` module.
+``datafusion.dataframe_formatter`` module.
 
 Configuring the HTML Formatter
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -183,7 +183,7 @@ You can customize how DataFrames are rendered by configuring the formatter:
 
 .. code-block:: python
 
-    from datafusion.html_formatter import configure_formatter
+    from datafusion.dataframe_formatter import configure_formatter
     
     configure_formatter(
         max_cell_length=30,              # Maximum length of cell content before truncation
@@ -206,7 +206,7 @@ For advanced styling needs, you can create a custom style provider class:
 
 .. code-block:: python
 
-    from datafusion.html_formatter import configure_formatter
+    from datafusion.dataframe_formatter import configure_formatter
     
     class CustomStyleProvider:
         def get_cell_style(self) -> str:
@@ -225,7 +225,7 @@ You can register custom formatters for specific data types:
 
 .. code-block:: python
 
-    from datafusion.html_formatter import get_formatter
+    from datafusion.dataframe_formatter import get_formatter
     
     formatter = get_formatter()
     
@@ -285,7 +285,7 @@ The HTML formatter maintains global state that can be managed:
 
 .. code-block:: python
 
-    from datafusion.html_formatter import reset_formatter, reset_styles_loaded_state, get_formatter
+    from datafusion.dataframe_formatter import reset_formatter, reset_styles_loaded_state, get_formatter
     
     # Reset the formatter to default settings
     reset_formatter()
@@ -303,7 +303,7 @@ This example shows how to create a dashboard-like styling for your DataFrames:
 
 .. code-block:: python
 
-    from datafusion.html_formatter import configure_formatter, get_formatter
+    from datafusion.dataframe_formatter import configure_formatter, get_formatter
     
     # Define custom CSS
     custom_css = """

python/datafusion/__init__.py

@@ -47,11 +47,11 @@
     SQLOptions,
 )
 from .dataframe import DataFrame, ParquetColumnOptions, ParquetWriterOptions
+from .dataframe_formatter import configure_formatter
 from .expr import (
     Expr,
     WindowFrame,
 )
-from .html_formatter import configure_formatter
 from .io import read_avro, read_csv, read_json, read_parquet
 from .plan import ExecutionPlan, LogicalPlan
 from .record_batch import RecordBatch, RecordBatchStream

python/datafusion/dataframe.py

@@ -52,7 +52,6 @@
     import polars as pl
     import pyarrow as pa
 
-    from datafusion._internal import DataFrame as DataFrameInternal
     from datafusion._internal import expr as expr_internal
 
 from enum import Enum
@@ -1112,3 +1111,17 @@ def fill_null(self, value: Any, subset: list[str] | None = None) -> DataFrame:
             - For columns not in subset, the original column is kept unchanged
         """
         return DataFrame(self.df.fill_null(value, subset))
+
+    @staticmethod
+    def default_str_repr(
+        batches: list[pa.RecordBatch],
+        schema: pa.Schema,
+        has_more: bool,
+        table_uuid: str | None = None,
+    ) -> str:
+        """Return the default string representation of a DataFrame.
+
+        This method is used by the default formatter and implemented in Rust for
+        performance reasons.
+        """
+        return DataFrameInternal.default_str_repr(batches, schema, has_more, table_uuid)

python/datafusion/html_formatter.py renamed to python/datafusion/dataframe_formatter.py

@@ -271,7 +271,7 @@ def is_styles_loaded(cls) -> bool:
             True if styles have been loaded, False otherwise
 
         Example:
-            >>> from datafusion.html_formatter import DataFrameHtmlFormatter
+            >>> from datafusion.dataframe_formatter import DataFrameHtmlFormatter
             >>> DataFrameHtmlFormatter.is_styles_loaded()
             False
         """

python/tests/test_dataframe.py

@@ -37,14 +37,14 @@
 from datafusion import (
     functions as f,
 )
-from datafusion.expr import Window
-from datafusion.html_formatter import (
+from datafusion.dataframe_formatter import (
     DataFrameHtmlFormatter,
     configure_formatter,
     get_formatter,
     reset_formatter,
     reset_styles_loaded_state,
 )
+from datafusion.expr import Window
 from pyarrow.csv import write_csv
 
 MB = 1024 * 1024

src/dataframe.rs

@@ -151,9 +151,9 @@ fn get_python_formatter_with_config(py: Python) -> PyResult<PythonFormatter> {
     Ok(PythonFormatter { formatter, config })
 }
 
-/// Get the Python formatter from the datafusion.html_formatter module
+/// Get the Python formatter from the datafusion.dataframe_formatter module
 fn import_python_formatter(py: Python) -> PyResult<Bound<'_, PyAny>> {
-    let formatter_module = py.import("datafusion.html_formatter")?;
+    let formatter_module = py.import("datafusion.dataframe_formatter")?;
     let get_formatter = formatter_module.getattr("get_formatter")?;
     get_formatter.call0()
 }