chore: Clean up get_extra_menu_items methods #50
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 guide (collapsed on small PRs)Reviewer's GuideCentralize extra menu item URL construction by introducing a static helper and refactor plugin and placeholder menu item methods to use it, removing legacy compatibility stubs. Class diagram for refactored menu item methods in cms_plugins.pyclassDiagram
class TransferPlugin {
+get_plugin_urls()
+get_extra_plugin_menu_items(request, plugin)
+get_extra_placeholder_menu_items(request, placeholder)
+import_plugins_view(request)
-_get_extra_menu_items(url_data, request)
}
TransferPlugin : static _get_extra_menu_items(url_data, request)
TransferPlugin : classmethod get_extra_plugin_menu_items(request, plugin)
TransferPlugin : classmethod get_extra_placeholder_menu_items(request, placeholder)
TransferPlugin : get_plugin_urls()
TransferPlugin : import_plugins_view(request)
TransferPlugin --> PluginMenuItem
TransferPlugin --> admin_reverse
TransferPlugin --> get_language_from_request
Flow diagram for centralized menu item URL constructionflowchart TD
A["get_extra_plugin_menu_items(request, plugin)"] --> B["_get_extra_menu_items({'plugin': plugin.pk}, request)"]
A2["get_extra_placeholder_menu_items(request, placeholder)"] --> B2["_get_extra_menu_items({'placeholder': placeholder.pk}, request)"]
B & B2 --> C["urlencode({language, ...url_data})"]
C --> D["Return PluginMenuItem list"]
File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
There was a problem hiding this comment.
Hey there - I've reviewed your changes - here's some feedback:
- The removal of get_extra_global_plugin_menu_items drops django-cms 3.4 compatibility—consider preserving it as a deprecated alias or adding a deprecation warning so clients relying on it have time to migrate.
- Consider renaming the url_data parameter in _get_extra_menu_items to something more descriptive like query_params for improved readability.
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- The removal of get_extra_global_plugin_menu_items drops django-cms 3.4 compatibility—consider preserving it as a deprecated alias or adding a deprecation warning so clients relying on it have time to migrate.
- Consider renaming the url_data parameter in _get_extra_menu_items to something more descriptive like query_params for improved readability.
## Individual Comments
### Comment 1
<location> `djangocms_transfer/cms_plugins.py:63-66` </location>
<code_context>
-
- @classmethod
- def get_extra_plugin_menu_items(cls, request, plugin):
- if plugin.plugin_type == cls.__name__:
- return
-
</code_context>
<issue_to_address>
**suggestion:** Returning None may be inconsistent with expected return type.
If a list is expected, return an empty list rather than None to maintain consistency and prevent issues for callers.
```suggestion
@classmethod
def get_extra_plugin_menu_items(cls, request, plugin):
if plugin.plugin_type == cls.__name__:
return []
```
</issue_to_address>Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
Comment on lines
+63
to
+66
| @classmethod | ||
| def get_extra_plugin_menu_items(cls, request, plugin): | ||
| if plugin.plugin_type == cls.__name__: | ||
| return |
There was a problem hiding this comment.
suggestion: Returning None may be inconsistent with expected return type.
If a list is expected, return an empty list rather than None to maintain consistency and prevent issues for callers.
Suggested change
| @classmethod | |
| def get_extra_plugin_menu_items(cls, request, plugin): | |
| if plugin.plugin_type == cls.__name__: | |
| return | |
| @classmethod | |
| def get_extra_plugin_menu_items(cls, request, plugin): | |
| if plugin.plugin_type == cls.__name__: | |
| return [] |
Codecov Report❌ Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## master #50 +/- ##
==========================================
- Coverage 58.82% 58.77% -0.05%
==========================================
Files 10 10
Lines 391 393 +2
Branches 56 56
==========================================
+ Hits 230 231 +1
- Misses 148 149 +1
Partials 13 13 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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
Not ready for merge yet
Related resources
Checklist
masterDiscord to find a “pr review buddy” who is going to review my pull request.
Summary by Sourcery
Extract common logic for building plugin and placeholder export/import menu items into a new static helper and remove the deprecated compatibility method
Enhancements: