8000 fix: Remove circular import in `cms.forms.validators` by fsbraun · Pull Request #8225 · django-cms/django-cms · GitHub
[go: up one dir, main page]
Skip to content

fix: Remove circular import in cms.forms.validators #8225

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
May 14, 2025
Merged

fix: Remove circular import in cms.forms.validators #8225

merged 4 commits into from
May 14, 2025

Conversation

fsbraun
Copy link
Member
@fsbraun fsbraun commented May 12, 2025 •
edited
Loading

Description

Removes an import on cms.forms.validators that can lead to a circular import.

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.

@sourcery-ai Sourcery AI
Copy link
Contributor
sourcery-ai bot commented May 12, 2025 •
edited
Loading

Reviewer's Guide

Refactors import logic to eliminate a circular dependency by deferring the Page model import under a TYPE_CHECKING guard and moving the validator import into its usage site.

File-Level Changes

Change Details Files
Defer Page model import to a TYPE_CHECKING block to avoid circular references
  • Added from typing import TYPE_CHECKING
  • Wrapped from cms.models.pagemodel import Page in an if TYPE_CHECKING: guard
  • Updated exclude_page type hint to use the forward reference "Page"
 cms/forms/validators.py
Move validate_url_uniqueness import into function scope to prevent top-level circular import
  • Inserted from cms.forms.validators import validate_url_uniqueness inside create_page_content
  • Ensured validator is only imported when the function is executed
 cms/api.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

👋 Hi there!

Please remember to MERGE COMMIT pull requests from main!

Do not SQUASH commits to preserve history for the changelog.

fsbraun
fsbraun commented May 13, 2025
View reviewed changes
@github-actions GitHub Actions
Copy link

👋 Hi there!

Please remember to MERGE COMMIT pull requests from main!

Do not SQUASH commits to preserve history for the changelog.

@github-actions GitHub Actions
Copy link

👋 Hi there!

Please remember to MERGE COMMIT pull requests from main!

Do not SQUASH commits to preserve history for the changelog.

@vinitkumar vinitkumar merged commit 1548fba into release/5.0.x May 14, 2025
66 checks passed
fsbraun added a commit that referenced this pull request May 22, 2025
@fsbraun @vinitkumar
fix: Page settings raised an exception when USE_I18N = False (#8236)
68aa0b3 
* fix: Remove circular import in `cms.forms.validators` (#8225)

* Remove circular import

* Fix linting

* Update cms/forms/validators.py

* fix: Do not assume page url cache is filled

* fix: Structure board update sometimes failed to add all interactive elements (#8227)

* fix: Scan plugin data after structure mode Xhr load

* Fix test

* fix js linting issues

* fix: Empty plugin selectors in all but first placeholder

* fix: Show all text-enabled plugins (#8229)

* fix: Adjust checks for GrouperAdmin to allow for `prepopulated_fields`

* fix: Page settings raised an exception when `USE_I18N = False`

* update ruff check

* Fix pk reference

---------

Co-authored-by: Vinit Kumar <mail@vinitkumar.me>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@vinitkumar vinitkumar vinitkumar approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@fsbraun @vinitkumar
0