django admin site search

django-admin-site-recherche

Un modal de recherche global/site pour l'administrateur Django.

Caractéristiques

• ? Fonctionne immédiatement, avec une configuration minimale.
• ? Recherche effectuée sur :
  • Étiquettes d'application.
  • Modélisez les étiquettes et les attributs de champ.
  • Instances de modèle, avec deux options pour une méthode de recherche :
    1. model_char_fields ( default ) : Toutes les valeurs CharField (et sous-classe), avec __icontains .
    2. admin_search_fields : appelle la méthode get_search_results(...) de chaque ModelAdmin.
• Authentification intégrée : les utilisateurs peuvent uniquement rechercher des applications et des modèles qu'ils sont autorisés à afficher.
• ⚡ Les résultats apparaissent sur type, avec limitation/anti-rebond pour éviter les demandes excessives.
• ? Navigation au clavier (cmd+k, haut/bas, entrée).
• Réactif et prend en charge le mode sombre/clair.
  • Les variables CSS intégrées de Django sont utilisées pour correspondre à votre thème d'administration.

Exigences

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

Installation

1. Installer

1. Installez avec votre gestionnaire de packages, par exemple pip install django-admin-site-search .
2. Ajoutez admin_site_search à votre paramètre INSTALLED_APPS .

2. Ajouter une vue

1. Si vous ne l'avez pas déjà fait, remplacez/étendez le site AdminSite par défaut.
2. Ajoutez AdminSiteSearchView à votre AdminSite :

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

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

3. Ajouter des modèles

1. Si vous ne l'avez pas déjà fait, créez admin/base_site.html dans votre répertoire templates/ .
   • Remarque : si votre répertoire templates/ se trouve dans une application, cette application doit apparaître dans INSTALLED_APPS avant votre application d'administration personnalisée.
2. Incluez les modèles admin_site_search :

{% 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 %}

Remarques

• Avec les styles, admin_site_search/head.html charge Alpine JS.
  • Ceci est regroupé dans /static/ , pour éviter les dépendances externes.
• Le placement de modal.html et button.html n'est pas strict, même si le premier occuperait idéalement une position de niveau supérieur.
  • Django 4.x expose {% block header %} - ceci est préférable à footer .

Personnalisation

Attributs de classe

 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" 

Méthodes

 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""" 

Exemple

Ajoutez les résultats TextField à la recherche.

 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 )

Notez que cela n'est pas fait par défaut pour des raisons de performances : __icontains sur un grand nombre d'entrées de texte n'est pas optimal.

Captures d'écran