mirror of
https://github.com/apache/superset.git
synced 2026-05-23 16:55:19 +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>
apache-superset-extensions-cli
Official command-line interface for building, bundling, and managing Apache Superset extensions. This CLI tool provides developers with everything needed to create, develop, and package extensions for the Superset ecosystem.
🚀 Features
- Extension Scaffolding - Generate initial folder structure and scaffold new extension projects
- Validation - Validate extension structure and configuration before building
- Development Server - Automatically rebuild extensions as files change during development
- Build System - Build extension assets for production deployment
- Bundle Packaging - Package extensions into distributable .supx files
📦 Installation
pip install apache-superset-extensions-cli
🛠️ Quick Start
Available Commands
# Scaffold a new extension project (interactive prompts, or pass options directly)
superset-extensions init [--publisher <publisher>] [--name <name>] [--display-name <name>]
[--version <version>] [--license <license>]
[--frontend/--no-frontend] [--backend/--no-backend]
# Validate extension structure and configuration
superset-extensions validate
# Build extension assets for production (runs validate first)
superset-extensions build
# Package extension into a distributable .supx file (runs build first)
superset-extensions bundle [--output/-o <path>]
# Automatically rebuild extension as files change during development
superset-extensions dev
📋 Extension Structure
The CLI scaffolds extensions with the following structure:
{publisher}.{name}/ # e.g., my-org.dashboard-widgets/
├── extension.json # Extension configuration and metadata
├── .gitignore
├── frontend/ # Optional frontend code
│ ├── src/
│ │ └── index.tsx # Frontend entry point
│ ├── package.json
│ ├── webpack.config.js
│ └── tsconfig.json
└── backend/ # Optional backend code
├── src/
│ └── {publisher}/ # e.g., my_org/
│ └── {name}/ # e.g., dashboard_widgets/
│ └── entrypoint.py
└── pyproject.toml
📄 License
Licensed under the Apache License, Version 2.0. See LICENSE for details.