fix: Allow lazy wizard initialization #8265
Merged
+93
−80
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Reviewer's GuideThis PR refactors wizard initialization to be lazy via a cached property in CMSCoreExtensions, centralizes and exposes core wizard helper functions in wizard_base, deprecates legacy helper and pool modules with warnings ahead of Django CMS 5.1, simplifies toolbar disabling logic to restore wizard availability on app-hooked pages, and updates tests to align with lazy loading and reset logic. Sequence diagram for lazy wizard access via get_entriessequenceDiagram
participant User
participant Toolbar
participant CMSCoreExtensions
participant Wizard
User->>Toolbar: Request wizard actions
Toolbar->>CMSCoreExtensions: Access wizards (via get_entries)
CMSCoreExtensions->>CMSCoreExtensions: Compute wizards (cached_property)
CMSCoreExtensions->>Wizard: Return sorted wizard instances
Toolbar->>User: Show available wizards
Class diagram for lazy wizard initialization in CMSCoreExtensionsclassDiagram
class CMSCoreExtensions {
+list lazy_wizards
+dict toolbar_enabled_models
+dict model_groupers
+list toolbar_mixins
+configure_wizards(cms_config)
+configure_toolbar_enabled_models(cms_config)
+wizards: dict[str, Wizard] <<cached_property>>
}
class Wizard {
+id
+weight
+title
+user_has_add_permission(user, page)
+get_model()
}
CMSCoreExtensions "1" o-- "*" Wizard : manages
Class diagram for new and deprecated wizard helper functionsclassDiagram
class wizard_base {
+get_entries()
+get_entry(entry_key)
+entry_choices(user, page)
}
class helpers {
+get_entries() <<deprecated>>
+get_entry(entry_key) <<deprecated>>
}
class wizard_pool {
+WizardPool <<deprecated>>
+entry_choices(user, page) <<deprecated>>
}
helpers ..> wizard_base : re-exports (deprecated)
wizard_pool ..> helpers : re-exports (deprecated)
wizard_pool ..> wizard_base : re-exports (deprecated)
File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
|
👋 Hi there! Please remember to MERGE COMMIT pull requests from Do not SQUASH commits to preserve history for the changelog. |
|
@sourcery-ai review |
There was a problem hiding this comment.
Hey @fsbraun - I've reviewed your changes - here's some feedback:
- The new
wizardscached_property silently merges duplicate wizard IDs—add a conflict check or warning to prevent unintended overrides of existing entries. - Misconfigured (non-Wizard) entries are only caught when accessing
wizards; consider validating input immediately inconfigure_wizardsto fail fast at startup. - In the
wizardsproperty the variable namewizardis reused in both the comprehension and thenextcall—rename one to avoid confusion and shadowing.
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- The new `wizards` cached_property silently merges duplicate wizard IDs—add a conflict check or warning to prevent unintended overrides of existing entries.
- Misconfigured (non-Wizard) entries are only caught when accessing `wizards`; consider validating input immediately in `configure_wizards` to fail fast at startup.
- In the `wizards` property the variable name `wizard` is reused in both the comprehension and the `next` call—rename one to avoid confusion and shadowing.
## Individual Comments
### Comment 1
<location> `cms/wizards/helpers.py:7` </location>
<code_context>
- Returns a wizard object based on its :attr:`~.cms.wizards.wizard_base.Wizard.id`.
- """
- return apps.get_app_config('cms').cms_extension.wizards[entry_key]
+warnings.warn(
+ "The cms.wizards.helpers module is deprecated and will be removed in django CMS 5.1. "
+ "Use cms.wizards.wizard_base.get_entries and cms.wizards.wizard_pool.get_entry instead.",
</code_context>
<issue_to_address>
Deprecation warning message references an incorrect replacement.
'wizard_pool.get_entry' does not exist in the codebase. Please update the warning to reference only valid alternatives to avoid user confusion.
</issue_to_address>Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
Co-authored-by: sourcery-ai[bot] <58596630+sourcery-ai[bot]@users.noreply.github.com>
|
👋 Hi there! Please remember to MERGE COMMIT pull requests from Do not SQUASH commits to preserve history for the changelog. |
Co-authored-by: sourcery-ai[bot] <58596630+sourcery-ai[bot]@users.noreply.github.com>
|
👋 Hi there! Please remember to MERGE COMMIT pull requests from Do not SQUASH commits to preserve history for the changelog. |
fsbraun
added a commit
that referenced
this pull request
Jun 28, 2025
* fix: Allow lazy wizard initialization * Update cms/cms_toolbars.py Co-authored-by: sourcery-ai[bot] <58596630+sourcery-ai[bot]@users.noreply.github.com> * Update cms/cms_config.py Co-authored-by: sourcery-ai[bot] <58596630+sourcery-ai[bot]@users.noreply.github.com> --------- Co-authored-by: sourcery-ai[bot] <58596630+sourcery-ai[bot]@users.noreply.github.com>
fsbraun
added a commit
that referenced
this pull request
Jun 28, 2025
* fix: Allow lazy wizard initialization * Update cms/cms_toolbars.py Co-authored-by: sourcery-ai[bot] <58596630+sourcery-ai[bot]@users.noreply.github.com> * Update cms/cms_config.py Co-authored-by: sourcery-ai[bot] <58596630+sourcery-ai[bot]@users.noreply.github.com> --------- Co-authored-by: sourcery-ai[bot] <58596630+sourcery-ai[bot]@users.noreply.github.com>
This was referenced Jun 28, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This PR fixes two issues and a chore:
RemovedInDjangoCMS51Warningto the legacy wizard pool (deprecated since Django CMS 4.0(!))Related resources
Checklist
mainSummary by Sourcery
Enable lazy wizard initialization in the CMS to avoid database access at startup, consolidate wizard registration into a cached property, add core helper functions in wizard_base, deprecate legacy helper and pool modules with warnings, and adjust toolbar logic and tests accordingly.
New Features:
Bug Fixes:
Enhancements:
Tests:
Summary by Sourcery
Implement lazy initialization of CMS wizards to avoid database access at startup, add helper functions for wizard access, restore toolbar wizard availability on app-hooked pages, and deprecate legacy wizard helper and pool modules with warnings
New Features:
Bug Fixes:
Enhancements:
Tests: