codeant-ai-for-open-source[bot] commented on code in PR #41133: URL: https://github.com/apache/superset/pull/41133#discussion_r3436858631
########## tests/unit_tests/utils/excel_streaming_tests.py: ########## @@ -0,0 +1,170 @@ +# 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 __future__ import annotations + +from datetime import date, datetime +from decimal import Decimal +from pathlib import Path + +import pytest + +from superset.utils import excel_streaming +from superset.utils.excel_streaming import ( + _sanitize_cell, + sanitize_sheet_name, + StreamingXlsxWriter, +) + +# --- sanitize_sheet_name --- + + +def test_sheet_name_replaces_forbidden_chars() -> None: + assert sanitize_sheet_name("a/b:c*d?e[f]g\\h", set()) == "a_b_c_d_e_f_g_h" + + +def test_sheet_name_truncated_to_31() -> None: + assert sanitize_sheet_name("x" * 40, set()) == "x" * 31 + + +def test_sheet_name_dedupes_case_insensitively() -> None: + used: set[str] = set() + assert sanitize_sheet_name("Sales", used) == "Sales" + assert sanitize_sheet_name("sales", used) == "sales~2" + assert sanitize_sheet_name("SALES", used) == "SALES~3" + + +def test_sheet_name_dedupe_marker_respects_length_cap() -> None: + used: set[str] = set() + long_name = "y" * 31 + assert sanitize_sheet_name(long_name, used) == long_name + assert sanitize_sheet_name(long_name, used) == "y" * 29 + "~2" + + +def test_sheet_name_blank_falls_back() -> None: + assert sanitize_sheet_name(" ", set()) == "Sheet" + + +def test_sheet_name_reserved_history_is_escaped() -> None: + assert sanitize_sheet_name("History", set()) == "History_" + + +def test_sheet_name_strips_surrounding_apostrophes() -> None: + assert sanitize_sheet_name("'quoted'", set()) == "quoted" + + +# --- _sanitize_cell --- + + [email protected]( + "value,expected", + [ + (None, ""), + ("=SUM(A1)", "'=SUM(A1)"), + ("+1", "'+1"), + ("-1", "'-1"), + ("@handle", "'@handle"), + ("normal", "normal"), + (True, True), + (5, 5), + (1.5, 1.5), + (Decimal("2.5"), 2.5), + (datetime(2020, 1, 2, 3, 4, 5), "2020-01-02T03:04:05"), + (date(2020, 1, 2), "2020-01-02"), + ], +) +def test_sanitize_cell(value: object, expected: object) -> None: + assert _sanitize_cell(value) == expected + + +def test_sanitize_cell_large_int_becomes_string() -> None: + assert _sanitize_cell(10**16) == str(10**16) + + +def test_sanitize_cell_non_finite_floats_blanked() -> None: + assert _sanitize_cell(float("nan")) == "" + assert _sanitize_cell(float("inf")) == "" + + +# --- StreamingXlsxWriter (round-trip via openpyxl) --- + + +def _read_workbook(path: str) -> dict[str, list[list[object]]]: + openpyxl = pytest.importorskip("openpyxl") + workbook = openpyxl.load_workbook(path, read_only=True) + sheets = { + ws.title: [list(row) for row in ws.iter_rows(values_only=True)] + for ws in workbook.worksheets + } + workbook.close() + return sheets + + +def test_writer_writes_one_sheet_per_chart(tmp_path: Path) -> None: + path = str(tmp_path / "out.xlsx") + writer = StreamingXlsxWriter(path) + assert writer.add_sheet("10 - First", ["a", "b"], [[1, 2], [3, 4]]) == 2 + assert writer.add_sheet("20 - Second", ["c"], [["x"]]) == 1 + writer.close() + + sheets = _read_workbook(path) + assert list(sheets.keys()) == ["10 - First", "20 - Second"] + assert sheets["10 - First"] == [["a", "b"], [1, 2], [3, 4]] + assert sheets["20 - Second"] == [["c"], ["x"]] + + +def test_writer_quotes_formula_cells(tmp_path: Path) -> None: + path = str(tmp_path / "out.xlsx") + writer = StreamingXlsxWriter(path) + writer.add_sheet("data", ["col"], [["=cmd()"]]) + writer.close() + + sheets = _read_workbook(path) + assert sheets["data"][1][0] == "'=cmd()" + + +def test_writer_caps_rows_per_sheet( + tmp_path: Path, monkeypatch: pytest.MonkeyPatch +) -> None: Review Comment: **Suggestion:** Add a docstring clarifying that this test checks row-limit enforcement when the per-sheet maximum is monkeypatched. [custom_rule] **Severity Level:** Minor ⚠️ <details> <summary><b>Why it matters? 🤔 </b></summary> This newly added function has no docstring in the final file state. The custom rule requires docstrings for new Python functions, so the suggestion is valid. </details> [](https://app.codeant.ai/fix-in-ide?tool=cursor&prompt_id=92786a9457514cbda6c1407b90839cc1&service=github&base_url=https%3A%2F%2Fgithub.com&org=apache&repo=apache%2Fsuperset) [](https://app.codeant.ai/fix-in-ide?tool=vscode-claude&prompt_id=92786a9457514cbda6c1407b90839cc1&service=github&base_url=https%3A%2F%2Fgithub.com&org=apache&repo=apache%2Fsuperset) *(Use Cmd/Ctrl + Click for best experience)* <details> <summary><b>Prompt for AI Agent 🤖 </b></summary> ```mdx This is a comment left during a code review. **Path:** tests/unit_tests/utils/excel_streaming_tests.py **Line:** 139:141 **Comment:** *Custom Rule: Add a docstring clarifying that this test checks row-limit enforcement when the per-sheet maximum is monkeypatched. Validate the correctness of the flagged issue. If correct, How can I resolve this? If you propose a fix, implement it and please make it concise. Once fix is implemented, also check other comments on the same PR, and ask user if the user wants to fix the rest of the comments as well. if said yes, then fetch all the comments validate the correctness and implement a minimal fix ``` </details> <a href='https://app.codeant.ai/feedback?pr_url=https%3A%2F%2Fgithub.com%2Fapache%2Fsuperset%2Fpull%2F41133&comment_hash=97dcbe4b6b0c430fcf992135e476b6b7cd92a4e561b829e4022556e7802a553e&reaction=like'>👍</a> | <a href='https://app.codeant.ai/feedback?pr_url=https%3A%2F%2Fgithub.com%2Fapache%2Fsuperset%2Fpull%2F41133&comment_hash=97dcbe4b6b0c430fcf992135e476b6b7cd92a4e561b829e4022556e7802a553e&reaction=dislike'>👎</a> -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
