mirror of
https://github.com/apache/superset.git
synced 2026-05-28 11:15:24 +00:00
dfd3f7b316
Follow-up to #40231 (merged), where a reviewer flagged a function-body `from datetime import datetime, timedelta` instead of a top-of-file import. Adds a `ruff-import-placement` pre-commit hook running `ruff check --select PLC0415 --preview --no-fix`. Per @rusackas's pushback on the first cut of this PR — which spammed 2,657 `# noqa: PLC0415` annotations across ~410 files without fixing anything — this revision is a much smaller surface area: 1. **Per-file-ignores** for whole directories where function-body imports are a deliberate pattern, not an oversight: - `superset/cli/**` and `scripts/**`: subcommand-deferred imports keep heavy modules out of the CLI startup path. - `superset/tasks/**`: Celery task bodies defer imports of the modules they orchestrate. - `superset/migrations/versions/**`: Alembic migrations interact with model state at runtime, not at module load. - `superset/mcp_service/**`: MCP tools lazy-load resources on invocation so the server can register many tools without paying their import cost at startup. - `superset/db_engine_specs/**`: engine specs defer driver imports so optional DB drivers don't have to be installed. - `superset/initialization/__init__.py`, `superset/extensions/__init__.py`, `superset/app.py`: the app-factory and extension wiring are intentionally full of circular-import workarounds. - `tests/**`: test files routinely defer imports for fixture isolation; the rule still applies to production code. 2. **Per-line `# noqa: PLC0415`** on the 259 remaining genuine circular-import sites (security/manager.py, sql/execution/executor.py, semantic_layers/labels.py, tags/core.py, core_api_injection.py, etc.). These are foundational modules where moving the imports up would actually break things. Net result: ~410 files / 2,657 grandfathered → ~73 files / 259 actual noqa annotations. The rule still catches every new function-body import outside the explicitly-allowed directories. Also: silences a pre-existing C901 on `mcp_service/sql_lab/tool/execute_sql.py` that fires under newer local ruff but not CI's pinned ruff 0.9.7 — blocks the local pre-commit run otherwise. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
95 lines
3.3 KiB
Python
95 lines
3.3 KiB
Python
# 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 logging
|
|
from io import StringIO
|
|
from typing import TYPE_CHECKING
|
|
|
|
import sshtunnel
|
|
from flask import Flask
|
|
from paramiko import RSAKey
|
|
|
|
from superset.commands.database.ssh_tunnel.exceptions import SSHTunnelDatabasePortError
|
|
from superset.databases.utils import make_url_safe
|
|
from superset.utils.class_utils import load_class_from_name
|
|
|
|
if TYPE_CHECKING:
|
|
from superset.databases.ssh_tunnel.models import SSHTunnel
|
|
|
|
|
|
class SSHManager:
|
|
def __init__(self, app: Flask) -> None:
|
|
super().__init__()
|
|
self.local_bind_address = app.config["SSH_TUNNEL_LOCAL_BIND_ADDRESS"]
|
|
sshtunnel.TUNNEL_TIMEOUT = app.config["SSH_TUNNEL_TIMEOUT_SEC"]
|
|
sshtunnel.SSH_TIMEOUT = app.config["SSH_TUNNEL_PACKET_TIMEOUT_SEC"]
|
|
|
|
def build_sqla_url(
|
|
self, sqlalchemy_url: str, server: sshtunnel.SSHTunnelForwarder
|
|
) -> str:
|
|
# override any ssh tunnel configuration object
|
|
url = make_url_safe(sqlalchemy_url)
|
|
return url.set(
|
|
host=server.local_bind_address[0],
|
|
port=server.local_bind_port,
|
|
)
|
|
|
|
def create_tunnel(
|
|
self,
|
|
ssh_tunnel: "SSHTunnel",
|
|
sqlalchemy_database_uri: str,
|
|
) -> sshtunnel.SSHTunnelForwarder:
|
|
from superset.utils.ssh_tunnel import get_default_port # noqa: PLC0415
|
|
|
|
url = make_url_safe(sqlalchemy_database_uri)
|
|
backend = url.get_backend_name()
|
|
port = url.port or get_default_port(backend)
|
|
if not port:
|
|
raise SSHTunnelDatabasePortError()
|
|
params = {
|
|
"ssh_address_or_host": (ssh_tunnel.server_address, ssh_tunnel.server_port),
|
|
"ssh_username": ssh_tunnel.username,
|
|
"remote_bind_address": (url.host, port),
|
|
"local_bind_address": (self.local_bind_address,),
|
|
"debug_level": logging.getLogger("flask_appbuilder").level,
|
|
}
|
|
|
|
if ssh_tunnel.password:
|
|
params["ssh_password"] = ssh_tunnel.password
|
|
elif ssh_tunnel.private_key:
|
|
private_key_file = StringIO(ssh_tunnel.private_key)
|
|
private_key = RSAKey.from_private_key(
|
|
private_key_file, ssh_tunnel.private_key_password
|
|
)
|
|
params["ssh_pkey"] = private_key
|
|
|
|
return sshtunnel.open_tunnel(**params)
|
|
|
|
|
|
class SSHManagerFactory:
|
|
def __init__(self) -> None:
|
|
self._ssh_manager = None
|
|
|
|
def init_app(self, app: Flask) -> None:
|
|
self._ssh_manager = load_class_from_name(
|
|
app.config["SSH_TUNNEL_MANAGER_CLASS"]
|
|
)(app)
|
|
|
|
@property
|
|
def instance(self) -> SSHManager:
|
|
return self._ssh_manager # type: ignore
|