django-cms
django-cms copied to clipboard
fix: Allow legacy PlaceholderField to be deconstructed
Description
A recent commit has removed the deconstruct method on the dummy PlaceholderField.
This breaks migrations with the error:
TypeError: "PlaceholderField" missing 1 required positional argument: slotname.
This PR adds the deconstruct method back and allows migrations reconstruct previous model state in migrations.
Checklist
- [x] I have opened this pull request against
main - [x] I have added or modified the tests when changing logic
- [x] I have followed the conventional commits guidelines to add meaningful information into the changelog
- [x] 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
Bug Fixes:
- Re-add deconstruct method to include the slotname argument and prevent migration errors when using PlaceholderField
Reviewer's Guide
Reintroduces the deconstruct method on PlaceholderField and retains the slotname attribute to ensure legacy migrations can reconstruct the field without errors.
Updated Class Diagram for PlaceholderField
classDiagram
class ForeignKey {
<<Django Model Field>>
+deconstruct(): tuple
}
PlaceholderField --|> ForeignKey
class PlaceholderField {
+slotname: string
+__init__(slotname, *args, **kwargs)
+deconstruct(): tuple
}
File-Level Changes
| Change | Details | Files |
|---|---|---|
Persist slotname on placeholder fields |
|
cms/models/fields.py |
Restore the deconstruct method for migrations |
|
cms/models/fields.py |
Tips and commands
Interacting with Sourcery
- Trigger a new review: Comment
@sourcery-ai reviewon 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 issueto create an issue from it. - Generate a pull request title: Write
@sourcery-aianywhere in the pull request title to generate a title at any time. You can also comment@sourcery-ai titleon the pull request to (re-)generate the title at any time. - Generate a pull request summary: Write
@sourcery-ai summaryanywhere in the pull request body to generate a PR summary at any time exactly where you want it. You can also comment@sourcery-ai summaryon the pull request to (re-)generate the summary at any time. - Generate reviewer's guide: Comment
@sourcery-ai guideon the pull request to (re-)generate the reviewer's guide at any time. - Resolve all Sourcery comments: Comment
@sourcery-ai resolveon 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 dismisson 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 reviewto 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
- Contact our support team for questions or feedback.
- Visit our documentation for detailed guides and information.
- Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.
@stefanw Oh, yes, indeed!
Shall we also add a system_check_removed_details message, e.g.:
system_check_removed_details = {
"msg": (
"PlaceholderField is for django CMS versions below 4 only. It may only be used inside migrations."
),
"hint": "Use PlaceholderRelationField instead.",
"id": "cms.E001",
}