Skip to content

fix: Allow lazy wizard initialization (#8266) #8283

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 4 commits into from
Jul 9, 2025
Merged

fix: Allow lazy wizard initialization (#8266) #8283

merged 4 commits into from
Jul 9, 2025

Conversation

fsbraun
Copy link
Member

@fsbraun fsbraun commented Jul 7, 2025 •
edited by sourcery-ai bot
Loading

Description

Backport of #8266

Related resources

Checklist

  • I have opened this pull request against main
  • I have added or modified the tests when changing logic
  • I have followed the conventional commits guidelines to add meaningful information into the changelog
  • I have read the contribution guidelines and I have joined the channel #pr-reviews on our Discord Server to find a “pr review buddy” who is going to review my pull request.

Summary by Sourcery

Extract wizard utility functions into a dedicated helpers module, update get_entries and entry_choices to support lazy loading of Wizard objects, and add a clear_wizard_cache function to allow dynamic refreshing of the wizard registry.

Enhancements:

  • Extract get_entries, get_entry, entry_choices, and clear_wizard_cache into a new cms.wizards.helpers module
  • Change get_entries to return a sorted list of Wizard objects and update entry_choices to yield (id, title) tuples
  • Add clear_wizard_cache to enable runtime clearing and reloading of registered wizards

@fsbraun @sourcery-ai
fix: Allow lazy wizard initialization (#8266)
1776b85 
* fix: Allow lazy wizard initialization (#8265)

* 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>

* feat: add "clear_wizard_cache"

* fix: Wizard pool depr message

* Update wizard_base.py

* fix  linting

---------

Co-authored-by: sourcery-ai[bot] <58596630+sourcery-ai[bot]@users.noreply.github.com>
@sourcery-ai Sourcery AI
Copy link
Contributor

sourcery-ai bot commented Jul 7, 2025 •
edited
Loading

Reviewer's Guide

This backport extracts wizard utility functions into a new helpers module, updates the get_entries API to return Wizard objects, adds a cache-clearing function for lazy initialization, and adjusts imports accordingly.

Class diagram for wizard utility refactor

classDiagram
    class WizardBase
    class Wizard
    class CMSAppConfig {
        +cms_extension
    }
    class CMSExtension {
        +wizards: dict
    }
    class User
    class Page

    CMSAppConfig --> CMSExtension : cms_extension
    CMSExtension --> Wizard : wizards
    WizardBase <|-- Wizard

    class helpers {
        +get_entries()
        +get_entry(entry_key)
        +entry_choices(user, page)
        +clear_wizard_cache()
    }

    helpers ..> Wizard : returns
    helpers ..> User : uses
    helpers ..> Page : uses
    helpers ..> CMSExtension : accesses wizards
Loading

File-Level Changes

Change Details Files
Extracted wizard utilities into a dedicated helpers module and updated imports
  • Moved get_entries, get_entry, entry_choices, clear_wizard_cache from wizard_base.py to helpers.py
  • Removed duplicate function definitions in wizard_base.py
  • Updated cms/wizards/wizard_pool.py to import get_entries and get_entry from helpers
 cms/wizards/wizard_base.py
cms/wizards/helpers.py
cms/wizards/wizard_pool.py
Changed get_entries API to return Wizard objects instead of tuples
  • Modified get_entries to return a sorted list of Wizard instances by weight
  • Updated get_entries docstrings and example loops to reflect new return signature
  • Adjusted entry_choices to yield (id, title) tuples based on new get_entries output
 cms/wizards/helpers.py
cms/wizards/wizard_base.py
Added clear_wizard_cache for lazy wizard registry initialization
  • Defined clear_wizard_cache to delete the apps.get_app_config('cms').cms_extension.wizards cache
  • Included docstring explaining usage when wizards are added or removed
 cms/wizards/helpers.py
cms/wizards/wizard_base.py
Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@github-actions GitHub Actions
Copy link

github-actions bot commented Jul 7, 2025

👋 Hi there!

Please remember to MERGE COMMIT pull requests from develop or develop-4!

Do not SQUASH commits to preserve history for the changelog.

@github-actions GitHub Actions
Copy link

github-actions bot commented Jul 7, 2025

👋 Hi there!

Please remember to MERGE COMMIT pull requests from develop or develop-4!

Do not SQUASH commits to preserve history for the changelog.

@github-actions GitHub Actions
Copy link

github-actions bot commented Jul 7, 2025

👋 Hi there!

Please remember to MERGE COMMIT pull requests from develop or develop-4!

Do not SQUASH commits to preserve history for the changelog.

@github-actions GitHub Actions
Copy link

github-actions bot commented Jul 7, 2025

👋 Hi there!

Please remember to MERGE COMMIT pull requests from develop or develop-4!

Do not SQUASH commits to preserve history for the changelog.

@fsbraun fsbraun merged commit 6044492 into release/4.1.x Jul 9, 2025
92 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@fsbraun