Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(mysql): handle string typed decimal results #24241

Merged
merged 7 commits into from
Sep 29, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 28 additions & 1 deletion superset/db_engine_specs/base.py
Original file line number Diff line number Diff line change
Expand Up @@ -323,6 +323,10 @@ class BaseEngineSpec: # pylint: disable=too-many-public-methods
# engine-specific type mappings to check prior to the defaults
column_type_mappings: tuple[ColumnTypeMapping, ...] = ()

# type-specific functions to mutate values received from the database.
# Needed on certain databases that return values in an unexpected format
column_type_mutators: dict[TypeEngine, Callable[[Any], Any]] = {}

# Does database support join-free timeslot grouping
time_groupby_inline = False
limit_method = LimitMethod.FORCE_LIMIT
Expand Down Expand Up @@ -743,7 +747,30 @@ def fetch_data(cls, cursor: Any, limit: int | None = None) -> list[tuple[Any, ..
try:
if cls.limit_method == LimitMethod.FETCH_MANY and limit:
return cursor.fetchmany(limit)
return cursor.fetchall()
data = cursor.fetchall()
description = cursor.description or []
# Create a mapping between column name and a mutator function to normalize
# values with. The first two items in the description row are
# the column name and type.
column_mutators = {
row[0]: func
for row in description
if (
func := cls.column_type_mutators.get(
type(cls.get_sqla_column_type(cls.get_datatype(row[1])))
Copy link
Member

Choose a reason for hiding this comment

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

Can we add a comment that explains the logic here? This dict comprehension might be hard to understand without the context of this PR

)
)
}
if column_mutators:
indexes = {row[0]: idx for idx, row in enumerate(description)}
for row_idx, row in enumerate(data):
new_row = list(row)
for col, func in column_mutators.items():
col_idx = indexes[col]
new_row[col_idx] = func(row[col_idx])
data[row_idx] = tuple(new_row)

return data
except Exception as ex:
raise cls.get_dbapi_mapped_exception(ex) from ex

Expand Down
6 changes: 5 additions & 1 deletion superset/db_engine_specs/mysql.py
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,9 @@
import contextlib
import re
from datetime import datetime
from decimal import Decimal
from re import Pattern
from typing import Any, Optional
from typing import Any, Callable, Optional
from urllib import parse

from flask_babel import gettext as __
Expand Down Expand Up @@ -126,6 +127,9 @@ class MySQLEngineSpec(BaseEngineSpec, BasicParametersMixin):
GenericDataType.STRING,
),
)
column_type_mutators: dict[types.TypeEngine, Callable[[Any], Any]] = {
DECIMAL: lambda val: Decimal(val) if isinstance(val, str) else val
}

_time_grain_expressions = {
None: "{col}",
Expand Down
40 changes: 40 additions & 0 deletions tests/unit_tests/db_engine_specs/test_mysql.py
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@
# under the License.

from datetime import datetime
from decimal import Decimal
from typing import Any, Optional
from unittest.mock import Mock, patch

Expand Down Expand Up @@ -220,3 +221,42 @@ def test_get_schema_from_engine_params() -> None:
)
== "db1"
)


@pytest.mark.parametrize(
"data,description,expected_result",
[
(
[("1.23456", "abc")],
[("dec", "decimal(12,6)"), ("str", "varchar(3)")],
[(Decimal("1.23456"), "abc")],
),
(
[(Decimal("1.23456"), "abc")],
[("dec", "decimal(12,6)"), ("str", "varchar(3)")],
[(Decimal("1.23456"), "abc")],
),
(
[(None, "abc")],
[("dec", "decimal(12,6)"), ("str", "varchar(3)")],
[(None, "abc")],
),
(
[("1.23456", "abc")],
[("dec", "varchar(255)"), ("str", "varchar(3)")],
[("1.23456", "abc")],
),
],
)
def test_column_type_mutator(
data: list[tuple[Any, ...]],
description: list[Any],
expected_result: list[tuple[Any, ...]],
):
from superset.db_engine_specs.mysql import MySQLEngineSpec as spec

mock_cursor = Mock()
mock_cursor.fetchall.return_value = data
mock_cursor.description = description

assert spec.fetch_data(mock_cursor) == expected_result