FrancescoCastaldi commented on code in PR #43695:
URL: https://github.com/apache/superset/pull/43695#discussion_r4418446810
##########
superset/db_engine_specs/ibmi.py:
##########
@@ -14,20 +14,41 @@
# KIND, either express or implied. See the License for the
# specific language governing permissions and limitations
# under the License.
+from superset.db_engine_specs.base import DatabaseCategory
+
from .db2 import Db2EngineSpec
class IBMiEngineSpec(Db2EngineSpec):
- """IBM Db2 for i (AS/400) engine spec.
-
- Note: Documentation is in Db2EngineSpec's compatible_databases section.
- This spec exists for runtime support of the ibmi driver.
- """
+ """IBM Db2 for i (AS/400) engine spec."""
engine = "ibmi"
engine_name = "IBM Db2 for i"
max_column_name_length = 128
+ metadata = {
+ "description": (
+ "IBM Db2 for i (formerly AS/400) is an integrated relational
database "
+ "engine on IBM Power systems running IBM i."
+ ),
+ "logo": "ibm-db2.svg",
+ "homepage_url": "https://www.ibm.com/products/db2-for-i";,
+ "categories": [
+ DatabaseCategory.TRADITIONAL_RDBMS,
+ DatabaseCategory.PROPRIETARY,
+ ],
+ "pypi_packages": ["sqlalchemy-ibmi"],
+ "connection_string": "ibmi://{username}:{password}@{host}/{database}",
+ "parameters": {
+ "username": "IBM i username",
+ "password": "IBM i password",
+ "host": "IBM i system host",
+ "database": "Library/schema name",
Review Comment:
Updated the parameter description for `database` in `IBMiEngineSpec`
metadata to explicitly say `RDB name` instead of `Library/schema name`.
##########
tests/unit_tests/db_engine_specs/test_lint_metadata.py:
##########
@@ -0,0 +1,65 @@
+# 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.
+
+import tempfile
+from pathlib import Path
+from textwrap import dedent
+
+from superset.db_engine_specs import lint_metadata
+from superset.db_engine_specs.lint_metadata import get_all_engine_specs_ast
+
+
+def test_get_all_engine_specs_ast_annotated_attributes() -> None:
+ """
+ Ensure engine specs with type-annotated engine, engine_name, and metadata
+ are correctly discovered and parsed by get_all_engine_specs_ast.
+ """
+ specs_dir = Path(lint_metadata.__file__).parent
+ code = dedent(
+ """
+ from typing import Any
+ from superset.db_engine_specs.base import BaseEngineSpec
+
+ class TypedBaseEngineSpec(BaseEngineSpec):
+ engine: str = "typed_engine"
+ engine_name: str = "Typed Engine"
+ metadata: dict[str, Any] = {
+ "description": "A typed engine spec",
+ }
+ """
+ )
+
+ with tempfile.NamedTemporaryFile(
+ mode="w",
+ dir=specs_dir,
Review Comment:
Addressed: `test_lint_metadata.py` redirects spec scanning to pytest's
`tmp_path` fixture via monkeypatching `SPECS_DIR`, completely avoiding writes
to the package source tree.
##########
superset/db_engine_specs/lint_metadata.py:
##########
@@ -272,10 +276,17 @@ def get_all_engine_specs_ast() -> list[dict[str, Any]]:
# noqa: C901
if isinstance(item, ast.Assign):
for target in item.targets:
if isinstance(target, ast.Name) and target.id ==
"engine":
- # Check if engine value is non-empty string
if isinstance(item.value, ast.Constant):
has_non_empty_engine =
bool(item.value.value)
break
+ elif isinstance(item, ast.AnnAssign):
+ if (
+ isinstance(item.target, ast.Name)
+ and item.target.id == "engine"
+ ):
+ if isinstance(item.value, ast.Constant):
+ has_non_empty_engine = bool(item.value.value)
+ break
Review Comment:
Addressed: updated the AST scanner in `lint_metadata.py` to continue past
bare type annotations without initializers until the actual assignment is
encountered, and added a dedicated test case
`test_get_all_engine_specs_ast_declaration_then_assignment` in
`test_lint_metadata.py`.
##########
superset/db_engine_specs/parseable.py:
##########
@@ -41,11 +41,14 @@ class ParseableEngineSpec(BaseEngineSpec):
"Parseable is a distributed log analytics database "
"with SQL-like query interface."
),
+ "logo": "parseable.png",
+ "homepage_url": "https://www.parseable.com";,
"categories": [DatabaseCategory.SEARCH_NOSQL,
DatabaseCategory.OPEN_SOURCE],
"pypi_packages": ["sqlalchemy-parseable"],
"connection_string": (
"parseable://{username}:{password}@{hostname}:{port}/{stream_name}"
),
+ "default_port": 8000,
Review Comment:
Updated `connection_string` in `ParseableEngineSpec` metadata to use
`parseable+http://` for port 8000, while retaining an explicit HTTPS entry
(`parseable+https://...:443`) in `connection_examples`.
--
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]
