django admin site search

django-admin-site-search

Django 管理者用のグローバル/サイト検索モーダル。

特徴

• ?最小限の構成ですぐに使用できます。
• ?検索は以下に対して実行されました:
  • アプリのラベル。
  • モデルのラベルとフィールドの属性。
  • モデル インスタンス。検索方法には 2 つのオプションがあります。
    1. model_char_fields (デフォルト): __icontainsを含むすべてのCharField (およびサブクラス) 値。
    2. admin_search_fields : 各 ModelAdmin の get_search_results(...) メソッドを呼び出します。
• 組み込み認証: ユーザーは、表示権限のあるアプリとモデルのみを検索できます。
• ⚡ 結果はオンタイプで表示され、過剰なリクエストを避けるためにスロットル/デバウンスが行われます。
• ?キーボード ナビゲーション (cmd+k、上/下、Enter)。
• レスポンシブでダーク/ライトモードをサポートします。
  • Django の組み込み CSS 変数は、管理テーマに一致させるために使用されます。

要件

• Python 3.7 ～ 3.12。
• ジャンゴ 3.2 ～ 5.1。

設定

1.インストール

1. パッケージマネージャーを使用してインストールします (例: pip install django-admin-site-search 。
2. INSTALLED_APPS設定にadmin_site_searchを追加します。

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最適ではありません。

スクリーンショット