[superset] branch master updated: fix: datetime with timezone excel export (#25318)

[beto]

This is an automated email from the ASF dual-hosted git repository.

beto pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/superset.git


The following commit(s) were added to refs/heads/master by this push:
     new 5ebcd2a5f6 fix: datetime with timezone excel export (#25318)
5ebcd2a5f6 is described below

commit 5ebcd2a5f69d2691f1e6c0ffc4a611c728cf4354
Author: Beto Dealmeida <robe...@dealmeida.net>
AuthorDate: Thu Sep 21 13:11:59 2023 -0700

    fix: datetime with timezone excel export (#25318)
    
    Co-authored-by: Michael S. Molina 
<70410625+michael-s-mol...@users.noreply.github.com>
---
 superset/utils/excel.py                                |  5 +++++
 .../excel.py => tests/unit_tests/utils/excel_tests.py  | 18 ++++++++++--------
 2 files changed, 15 insertions(+), 8 deletions(-)

diff --git a/superset/utils/excel.py b/superset/utils/excel.py
index 1f68031b64..ccbeadee5e 100644
--- a/superset/utils/excel.py
+++ b/superset/utils/excel.py
@@ -22,6 +22,11 @@ import pandas as pd
 
 def df_to_excel(df: pd.DataFrame, **kwargs: Any) -> Any:
     output = io.BytesIO()
+
+    # timezones are not supported
+    for column in df.select_dtypes(include=["datetimetz"]).columns:
+        df[column] = df[column].astype(str)
+
     # pylint: disable=abstract-class-instantiated
     with pd.ExcelWriter(output, engine="xlsxwriter") as writer:
         df.to_excel(writer, **kwargs)
diff --git a/superset/utils/excel.py b/tests/unit_tests/utils/excel_tests.py
similarity index 67%
copy from superset/utils/excel.py
copy to tests/unit_tests/utils/excel_tests.py
index 1f68031b64..c15f69a0c6 100644
--- a/superset/utils/excel.py
+++ b/tests/unit_tests/utils/excel_tests.py
@@ -14,16 +14,18 @@
 # KIND, either express or implied.  See the License for the
 # specific language governing permissions and limitations
 # under the License.
-import io
-from typing import Any
+
+from datetime import datetime, timezone
 
 import pandas as pd
 
+from superset.utils.excel import df_to_excel
 
-def df_to_excel(df: pd.DataFrame, **kwargs: Any) -> Any:
-    output = io.BytesIO()
-    # pylint: disable=abstract-class-instantiated
-    with pd.ExcelWriter(output, engine="xlsxwriter") as writer:
-        df.to_excel(writer, **kwargs)
 
-    return output.getvalue()
+def test_timezone_conversion() -> None:
+    """
+    Test that columns with timezones are converted to a string.
+    """
+    df = pd.DataFrame({"dt": [datetime(2023, 1, 1, 0, 0, 
tzinfo=timezone.utc)]})
+    contents = df_to_excel(df)
+    assert pd.read_excel(contents)["dt"][0] == "2023-01-01 00:00:00+00:00"