{"title":"カスタム shell コマンドの作り方","version":"5.2","locale":"ja","docname":"howto/custom-shell","url":"/ja/5.2/howto/custom-shell/","canonical":"https://djangodocs.dev/ja/5.2/howto/custom-shell/","summary":"Djangoの shell は、モデルと設定へのアクセスを提供する対話型の Python 環境であり、コードのテスト、クエリの実験、アプリケーションデータとのやりとりに役立ちます。 shell コマンドをカスタマイズすることで、機能を追加したり、特定のモジュールをプリロードしたりできます。そのためには、…","html":"<h1>カスタム <code class=\"docutils literal notranslate\"><span class=\"pre\">shell</span></code> コマンドの作り方<a class=\"heading-anchor\" href=\"#how-to-customize-the-shell-command\"><span class=\"visually-hidden\">Link to this heading</span><span aria-hidden=\"true\">#</span></a></h1>\n<p>Djangoの <a class=\"reference internal\" href=\"/ja/5.2/ref/django-admin/#django-admin-shell\"><code class=\"xref std std-djadmin docutils literal notranslate\"><span class=\"pre\">shell</span></code></a> は、モデルと設定へのアクセスを提供する対話型の Python 環境であり、コードのテスト、クエリの実験、アプリケーションデータとのやりとりに役立ちます。</p>\n<p><a class=\"reference internal\" href=\"/ja/5.2/ref/django-admin/#django-admin-shell\"><code class=\"xref std std-djadmin docutils literal notranslate\"><span class=\"pre\">shell</span></code></a> コマンドをカスタマイズすることで、機能を追加したり、特定のモジュールをプリロードしたりできます。そのためには、 <code class=\"docutils literal notranslate\"><span class=\"pre\">django.core.management.commands.shell.Command</span></code> のサブクラスを作成し、既存の <code class=\"docutils literal notranslate\"><span class=\"pre\">shell</span></code> 管理コマンドをオーバーライドする新しい管理コマンドを作成します。詳細については、 <a class=\"reference internal\" href=\"/ja/5.2/howto/custom-management-commands/#overriding-commands\"><span class=\"std std-ref\">コマンドのオーバーライド</span></a> に関するガイドを参照してください。</p>\n<section id=\"customize-automatic-imports\">\n<span id=\"customizing-shell-auto-imports\"></span><h2>自動インポートをカスタマイズする<a class=\"heading-anchor\" href=\"#customize-automatic-imports\"><span class=\"visually-hidden\">Link to this heading</span><span aria-hidden=\"true\">#</span></a></h2>\n<aside class=\"version-note version-added\" data-version=\"5.2\">\n<p class=\"version-note-title\">New in Django 5.2</p></aside>\n<p><a class=\"reference internal\" href=\"/ja/5.2/ref/django-admin/#django-admin-shell\"><code class=\"xref std std-djadmin docutils literal notranslate\"><span class=\"pre\">shell</span></code></a> 管理コマンドの自動インポート動作をカスタマイズするには、 <code class=\"docutils literal notranslate\"><span class=\"pre\">get_auto_imports()</span></code> メソッドをオーバーライドします。このメソッドは、アプリケーションで利用可能なオブジェクトまたはモジュールのインポートパスのシーケンスを返す必要があります。例えば:</p>\n<figure class=\"code-block code-block-captioned\" data-language=\"python\"><figcaption class=\"code-block-caption\"><code class=\"docutils literal notranslate\"><span class=\"pre\">polls/management/commands/shell.py</span></code></figcaption>\n<div class=\"code-block-toolbar\"><span class=\"code-block-language\">Python</span><button type=\"button\" class=\"copy-button\" data-copy hidden><span class=\"copy-button-label\">Copy</span></button></div><pre role=\"group\" tabindex=\"0\" aria-label=\"Python code\"><code><span class=\"kn\">from</span><span class=\"w\"> </span><span class=\"nn\">django.core.management.commands</span><span class=\"w\"> </span><span class=\"kn\">import</span> <span class=\"n\">shell</span>\n\n\n<span class=\"k\">class</span><span class=\"w\"> </span><span class=\"nc\">Command</span><span class=\"p\">(</span><span class=\"n\">shell</span><span class=\"o\">.</span><span class=\"n\">Command</span><span class=\"p\">):</span>\n    <span class=\"k\">def</span><span class=\"w\"> </span><span class=\"nf\">get_auto_imports</span><span class=\"p\">(</span><span class=\"bp\">self</span><span class=\"p\">):</span>\n        <span class=\"k\">return</span> <span class=\"nb\">super</span><span class=\"p\">()</span><span class=\"o\">.</span><span class=\"n\">get_auto_imports</span><span class=\"p\">()</span> <span class=\"o\">+</span> <span class=\"p\">[</span>\n            <span class=\"s2\">&quot;django.urls.reverse&quot;</span><span class=\"p\">,</span>\n            <span class=\"s2\">&quot;django.urls.resolve&quot;</span><span class=\"p\">,</span>\n        <span class=\"p\">]</span>\n</code></pre></figure>\n<p>上記のカスタマイズにより、 <a class=\"reference internal\" href=\"/ja/5.2/ref/urlresolvers/#django.urls.resolve\" title=\"django.urls.resolve\"><code class=\"xref py py-func docutils literal notranslate\"><span class=\"pre\">resolve()</span></code></a> と <a class=\"reference internal\" href=\"/ja/5.2/ref/urlresolvers/#django.urls.reverse\" title=\"django.urls.reverse\"><code class=\"xref py py-func docutils literal notranslate\"><span class=\"pre\">reverse()</span></code></a> がデフォルトの名前空間に追加されます。この名前空間には、すでに <a class=\"reference internal\" href=\"/ja/5.2/ref/settings/#std-setting-INSTALLED_APPS\"><code class=\"xref std std-setting docutils literal notranslate\"><span class=\"pre\">INSTALLED_APPS</span></code></a> に含まれるアプリのすべてのモデルが含まれています。これらのオブジェクトは、 <code class=\"docutils literal notranslate\"><span class=\"pre\">shell</span></code> 内で手動でインポートすることなく利用できるようになります。</p>\n<p>このようにカスタムした <code class=\"docutils literal notranslate\"><span class=\"pre\">shell</span></code> コマンドを <code class=\"docutils literal notranslate\"><span class=\"pre\">verbosity=2</span></code> を付けて実行すると、次のように表示されます：</p>\n<div class=\"code-block\" data-language=\"console\"><div class=\"code-block-toolbar\"><span class=\"code-block-language\">Shell</span><button type=\"button\" class=\"copy-button\" data-copy hidden><span class=\"copy-button-label\">Copy</span></button></div><pre role=\"group\" tabindex=\"0\" aria-label=\"Shell code\"><code><span class=\"go\">8 objects imported automatically:</span>\n\n<span class=\"go\">  from django.contrib.admin.models import LogEntry</span>\n<span class=\"go\">  from django.contrib.auth.models import Group, Permission, User</span>\n<span class=\"go\">  from django.contrib.contenttypes.models import ContentType</span>\n<span class=\"go\">  from django.contrib.sessions.models import Session</span>\n<span class=\"go\">  from django.urls import resolve, reverse</span>\n</code></pre></div>\n<p>オーバーライドされた <code class=\"docutils literal notranslate\"><span class=\"pre\">shell</span></code> コマンドにインポートできないパスが含まれている場合、 <code class=\"docutils literal notranslate\"><span class=\"pre\">verbosity</span></code> を <code class=\"docutils literal notranslate\"><span class=\"pre\">1</span></code> 以上に設定するとエラーが表示されます。重複したインポートは自動的に処理されます。</p>\n<p>特定の <code class=\"docutils literal notranslate\"><span class=\"pre\">shell</span></code> セッションで自動インポートを無効にしたい場合は、 <a class=\"reference internal\" href=\"/ja/5.2/ref/django-admin/#cmdoption-shell-no-imports\"><code class=\"xref std std-option docutils literal notranslate\"><span class=\"pre\">--no-imports</span></code></a> フラグを使用してください。自動インポートを恒久的に無効にするには、<code class=\"docutils literal notranslate\"><span class=\"pre\">get_auto_imports()</span></code> をオーバーライドして <code class=\"docutils literal notranslate\"><span class=\"pre\">None</span></code> を返すようにします：</p>\n<div class=\"code-block\" data-language=\"default\"><div class=\"code-block-toolbar\"><span class=\"code-block-language\">Code</span><button type=\"button\" class=\"copy-button\" data-copy hidden><span class=\"copy-button-label\">Copy</span></button></div><pre role=\"group\" tabindex=\"0\" aria-label=\"Code code\"><code><span class=\"k\">class</span><span class=\"w\"> </span><span class=\"nc\">Command</span><span class=\"p\">(</span><span class=\"n\">shell</span><span class=\"o\">.</span><span class=\"n\">Command</span><span class=\"p\">):</span>\n    <span class=\"k\">def</span><span class=\"w\"> </span><span class=\"nf\">get_auto_imports</span><span class=\"p\">(</span><span class=\"bp\">self</span><span class=\"p\">):</span>\n        <span class=\"k\">return</span> <span class=\"kc\">None</span>\n</code></pre></div>\n</section>","rootId":"how-to-customize-the-shell-command","toc":[{"title":"自動インポートをカスタマイズする","anchor":"customize-automatic-imports","children":[]}],"breadcrumbs":[{"docname":"howto/index","title":"How-to ガイド","url":"/ja/5.2/howto/"}],"prev":{"docname":"howto/custom-management-commands","title":"カスタム django-admin コマンドの作り方","url":"/ja/5.2/howto/custom-management-commands/"},"next":{"docname":"faq/index","title":"Django FAQ よくある質問","url":"/ja/5.2/faq/"},"formats":{"html":"/ja/5.2/howto/custom-shell/","markdown":"/ja/5.2/howto/custom-shell.md","json":"/ja/5.2/howto/custom-shell.json"},"source":"https://github.com/django/django/blob/stable/5.2.x/docs/howto/custom-shell.txt","official":"https://docs.djangoproject.com/ja/5.2/howto/custom-shell/","inVersions":["6.1","6.0","5.2"],"inLocales":["en","sv","zh-hans","ga","fr","ja","id","it","pt-br","ko","es","el","pl"]}