Skip to content
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.

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

fix: Remove user from autocomplete fields if (swapped) user model does not have search fields #1517

Open
wants to merge 12 commits into
base: master
Choose a base branch
from

Conversation

fsbraun
Copy link
Member

@fsbraun fsbraun commented Mar 4, 2025

Description

This PR fixes #1478. The user field is dropped from autocomplete_fields if the user model does not define search_fields.

Related resources

Checklist

  • I have opened this pull request against master
  • 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 #workgroup-pr-review on
    Slack to find a “pr review buddy” who is going to review my pull request.

Summary by Sourcery

Fixes an issue where the user field was not dropped from autocomplete_fields when the user model did not define search_fields. Also adds virus check for binary files without a specific mime type.

Bug Fixes:

  • Removes the user field from autocomplete_fields if the user model does not define search_fields.
  • Adds virus check for binary files without a specific mime type.

Copy link
Contributor

sourcery-ai bot commented Mar 4, 2025

Reviewer's Guide by Sourcery

This pull request addresses issue #1478 by removing the user field from the autocomplete_fields in the PermissionAdmin if the user model does not define search_fields. This is achieved by overriding the get_autocomplete_fields method and conditionally removing the user field based on the presence of search_fields in the user model admin.

No diagrams generated as the changes look simple and do not need a visual representation.

File-Level Changes

Change Details Files
The user field is removed from autocomplete_fields if the user model does not define search_fields.
  • Override get_autocomplete_fields to conditionally remove the user field.
  • Check if the user model admin has search_fields defined.
  • Remove user from autocomplete_fields if search_fields is not defined.
filer/admin/permissionadmin.py

Assessment against linked issues

Issue Objective Addressed Explanation
#1478 Remove the requirement for search_fields in ModelAdmin when a custom user model without search_fields is used in autocomplete_fields.

Possibly linked issues


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!
  • Generate a plan of action for an issue: Comment @sourcery-ai plan on
    an issue to generate a plan of action for it.

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

Copy link
Contributor

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey @fsbraun - I've reviewed your changes - here's some feedback:

Overall Comments:

  • Consider adding a test case to ensure the autocomplete_fields are correctly updated when the user model lacks search_fields.
Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟢 Documentation: all looks good

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@fsbraun fsbraun requested a review from a team March 6, 2025 20:20
@fsbraun fsbraun force-pushed the fix/user-model-searchfield branch from fa521a6 to 859db85 Compare March 6, 2025 21:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Custom user model's ModelAdmin must define "search_fields",
1 participant