django admin site search

django-admin-site-search

Ein globales/Site-Suchmodal für den Django-Administrator.

Merkmale

• ? Funktioniert sofort, mit minimaler Konfiguration.
• ? Suche durchgeführt am:
  • App-Labels.
  • Modellbezeichnungen und Feldattribute.
  • Modellinstanzen mit zwei Optionen für eine Suchmethode:
    1. model_char_fields ( Standard ): Alle CharField Werte (und Unterklassenwerte) mit __icontains .
    2. admin_search_fields : Rufen Sie die get_search_results(...)-Methode jedes ModelAdmins auf.
• Integrierte Authentifizierung: Benutzer können nur nach Apps und Modellen suchen, für deren Anzeige sie berechtigt sind.
• ⚡ Die Ergebnisse werden typgerecht angezeigt, mit Drosselung/Entprellung, um übermäßige Anfragen zu vermeiden.
• ? Tastaturnavigation (cmd+k, hoch/runter, Eingabetaste).
• Reaktionsschnell und unterstützt den Dunkel-/Hellmodus.
  • Die integrierten CSS-Variablen von Django werden passend zu Ihrem Admin-Theme verwendet.

Anforderungen

• Python 3.7 - 3.12.
• Django 3.2 - 5.1.

Aufstellen

1. Installieren

1. Installieren Sie es mit Ihrem Paketmanager, z. B. pip install django-admin-site-search .
2. Fügen Sie admin_site_search zu Ihrer INSTALLED_APPS -Einstellung hinzu.

2. Ansicht hinzufügen

1. Falls Sie dies noch nicht getan haben, überschreiben/erweitern Sie die Standard-AdminSite.
2. Fügen Sie die AdminSiteSearchView zu Ihrer AdminSite hinzu:

 from django . contrib import admin
from admin_site_search . views import AdminSiteSearchView

class MyAdminSite ( AdminSiteSearchView , admin . AdminSite ):
    ...

3. Vorlagen hinzufügen

1. Wenn Sie dies noch nicht getan haben, erstellen Sie admin/base_site.html in Ihrem templates/ -Verzeichnis.
   • Hinweis: Wenn sich Ihr templates/ -Verzeichnis in einer App befindet, muss diese App in INSTALLED_APPS vor Ihrer benutzerdefinierten Admin-App erscheinen.
2. Fügen Sie die admin_site_search -Vorlagen ein:

{% extends "admin/base_site.html" %}

{% block extrahead %}
    {% include 'admin_site_search/head.html' %}
    {{ block.super }}
{% endblock %}

{% block footer %}
    {{ block.super }}
    {% include 'admin_site_search/modal.html' %}
{% endblock %}

{% block usertools %}
    {% include 'admin_site_search/button.html' %}
    {{ block.super }}
{% endblock %}

Notizen

• Zusammen mit Stilen lädt admin_site_search/head.html Alpine JS.
  • Dies ist in /static/ gebündelt, um externe Abhängigkeiten zu vermeiden.
• Die Platzierung von modal.html und button.html ist nicht streng, erstere wäre jedoch idealerweise auf der obersten Ebene.
  • Django 4.x macht {% block header %} verfügbar – dies ist dem footer vorzuziehen.

Anpassung

Klassenattribute

 class MyAdminSite ( AdminSiteSearchView , admin . AdminSite ):
    
    # Sets the last part of the search route (`<admin_path>/search/`).
    site_search_path : str = "search/"
    # Set the search method/behaviour.
    site_search_method : Literal [ "model_char_fields" , "admin_search_fields" ] = "model_char_fields" 

Methoden

 def match_app (
    self , request , query : str , name : str
) -> bool :
    """DEFAULT: case-insensitive match the app name"""

def match_model (
    self , request , query : str , name : str , object_name : str , fields : List [ Field ]
) -> bool :
    """DEFAULT: case-insensitive match the model and field attributes"""

def match_objects (
    self , request , query : str , model_class : Model , model_fields : List [ Field ]
) -> QuerySet :
    """DEFAULT: Returns the QuerySet after performing an OR filter across all Char fields in the model."""

def filter_field (
    self , request , query : str , field : Field
) -> Optional [ Q ]:
    """DEFAULT: Returns a Q 'icontains' filter for Char fields, otherwise None
    
    Note: this method is only invoked if model_char_fields is the site_search_method."""

def get_model_queryset (
    self , request , model_class : Model , model_admin : Optional [ ModelAdmin ]
) -> QuerySet :
    """DEFAULT: Returns the model class' .objects.all() queryset."""

def get_model_class (
    self , request , app_label : str , model_dict : dict
) -> Optional [ Model ]:
    """DEFAULT: Retrieve the model class from the dict created by admin.AdminSite""" 

Beispiel

Fügen Sie TextField Ergebnisse zur Suche hinzu.

 from django . contrib import admin
from django . db . models import Q , Field , TextField
from admin_site_search . views import AdminSiteSearchView


class MyAdminSite ( AdminSiteSearchView , admin . AdminSite ):
    
    site_search_method : "model_char_fields"  
  
    def filter_field ( self , request , query : str , field : Field ) -> Optional [ Q ]:
        """Extends super() to add TextField support to site search"""
        if isinstance ( field , TextField ):
            return Q ( ** { f" { field . name } __icontains" : query })
        return super (). filter_field ( query , field )

Beachten Sie, dass dies aus Leistungsgründen nicht standardmäßig erfolgt: __icontains ist bei einer großen Anzahl von Texteinträgen nicht optimal.

Screenshots