mirror of
https://github.com/apache/superset.git
synced 2026-05-22 00:05:15 +00:00
4266d36cf4
Snapshots all four versioned Docusaurus sections at v6.1.0, cut from master after the version-cutting tooling (#39837) and broken-internal- links fixes (#40102) landed. Captures fresh auto-generated content and freezes data dependencies so the historical snapshot stays correct. Versioning behavior: lastVersion stays at current for every section, so the canonical URLs (/docs/..., /admin-docs/..., /developer-docs/..., /components/...) continue to render content from master. The current version is consistently labeled "Next" with an unreleased banner, and 6.1.0 is a historical pin accessible only via its explicit version segment. Component playground: previously disabled: true in versions-config.json, now enabled and versioned. The plugin block in docusaurus.config.ts was already gated only by the disabled flag, so no other code changes were needed to bring it back online. Snapshot includes: - All MDX content for the four sections. - Auto-gen captured fresh: 74 database pages (engine spec metadata), ~1,800 API reference files (openapi.json), 59 component pages (Storybook stories). - Data imports frozen at cut time into snapshot-local _versioned_data/ dirs: versioned_docs/version-6.1.0/_versioned_data/src/data/databases.json (canonical 80-database diagnostics from master, preserved by the generator's input-hash cache) admin_docs_versioned_docs/version-6.1.0/_versioned_data/data/countries.json admin_docs_versioned_docs/version-6.1.0/_versioned_data/static/feature-flags.json developer_docs_versioned_docs/version-6.1.0/_versioned_data/static/data/components.json - Import paths in deeply-nested files rewritten so they still resolve from one directory deeper inside the snapshot. Verified via full yarn build: exit 0, no broken links surfaced by onBrokenLinks: throw. Anchor warnings present are pre-existing on master (community#superset-community-calendar) and unrelated.
2.8 KiB
2.8 KiB
title, sidebar_position
| title | sidebar_position |
|---|---|
| pkg_resources Migration Guide | 9 |
pkg_resources Deprecation and Migration Guide
Background
As of setuptools 81.0.0, the pkg_resources API is deprecated and will be removed. This affects several packages in the Python ecosystem.
Current Status
Superset Codebase
The Superset codebase has already migrated away from pkg_resources to the modern importlib.metadata API:
superset/db_engine_specs/__init__.py- Usesfrom importlib.metadata import entry_points- All entry point loading uses the modern API
Production Dependencies
Some third-party dependencies may still use pkg_resources. Monitor your dependency tree for packages that haven't migrated yet.
Migration Path
Short-term Solution
Pin setuptools to version 80.x to prevent breaking changes:
# requirements/base.in
setuptools<81
This prevents the removal of pkg_resources while dependent packages are updated.
Long-term Solution
Update all dependencies to use importlib.metadata instead of pkg_resources:
Migration Example
Old (deprecated):
import pkg_resources
version = pkg_resources.get_distribution("package_name").version
entry_points = pkg_resources.iter_entry_points("group_name")
New (recommended):
from importlib.metadata import version, entry_points
pkg_version = version("package_name")
eps = entry_points(group="group_name")
Action Items
For Superset Maintainers
- The Superset codebase already uses
importlib.metadata - Monitor third-party dependencies for updates
- Update setuptools pin once the ecosystem is ready
For Extension Developers
- Update your packages to use
importlib.metadatainstead ofpkg_resources - Test with setuptools >= 81.0.0 once all packages are migrated