fix: datetime with timezone excel export (#25318)

Co-authored-by: Michael S. Molina <70410625+michael-s-molina@users.noreply.github.com>
(cherry picked from commit 5ebcd2a)

superset/migrations/versions/2023-09-15_12-58_4b85906e5b91_add_on_delete_cascade_for_dashboard_roles.py

@@ -17,14 +17,14 @@
 """add on delete cascade for dashboard_roles
 
 Revision ID: 4b85906e5b91
-Revises: 317970b4400c
+Revises: ec54aca4c8a2
 Create Date: 2023-09-15 12:58:26.772759
 
 """
 
 # revision identifiers, used by Alembic.
 revision = "4b85906e5b91"
-down_revision = "317970b4400c"
+down_revision = "ec54aca4c8a2"
 
 
 from superset.migrations.shared.constraints import ForeignKey, redefine

superset/utils/excel.py

@@ -22,6 +22,11 @@
 
 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)

tests/unit_tests/utils/excel_tests.py

@@ -0,0 +1,31 @@
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License.  You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+from datetime import datetime, timezone
+
+import pandas as pd
+
+from superset.utils.excel import df_to_excel
+
+
+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"