django admin site search

django-admin-站點搜索

Django 管理員的全域/網站搜尋模式。

特徵

• ？開箱即用，配置最少。
• ？搜尋執行於：
  • 應用程式標籤。
  • 模型標籤和字段屬性。
  • 模型實例，有兩種搜尋方法選項：
    1. model_char_fields （預設）：所有CharField （和子類別）值，帶有__icontains 。
    2. admin_search_fields ：呼叫每個 ModelAdmin 的 get_search_results(...) 方法。
• 內建授權：使用者只能搜尋自己有權限查看的應用程式和模型。
• ⚡ 結果按類型顯示，並透過節流/去抖動來避免過多的請求。
• ？鍵盤導航（cmd+k、向上/向下、輸入）。
• 響應式，支援暗/亮模式。
  • Django 的內建 CSS 變數用於匹配您的管理主題。

要求

• Python 3.7 - 3.12。
• 姜戈 3.2 - 5.1。

設定

1. 安裝

1. 使用套件管理器安裝，例如pip install django-admin-site-search 。
2. 將admin_site_search加入您的INSTALLED_APPS設定中。

2. 新增視圖

1. 如果您還沒有這樣做，請覆蓋/擴展預設的 AdminSite。
2. 將AdminSiteSearchView新增至您的 AdminSite：

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

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

3. 新增模板

1. 如果尚未建立，請在templates/目錄中建立admin/base_site.html 。
   • 注意：如果您的templates/目錄位於應用程式內部，則該應用程式必須出現在INSTALLED_APPS中，位於您的自訂管理應用程式之前。
2. 包含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 %}

筆記

• 除了樣式之外， admin_site_search/head.html也載入 Alpine JS。
  • 這被捆綁到/static/中，以避免外部依賴。
• modal.html和button.html的放置並不嚴格，儘管前者最好位於頂級位置。
  • Django 4.x 公開了{% block header %} - 這比footer更好。

客製化

類別屬性

 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" 

方法

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

例子

將TextField位結果新增至搜尋。

 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 )

請注意，出於效能原因，預設不會這樣做：大量文字條目上的__icontains不是最佳選擇。

截圖