{"title":"如何自定义 shell 命令","version":"6.0","locale":"zh-hans","docname":"howto/custom-shell","url":"/zh-hans/6.0/howto/custom-shell/","canonical":"https://djangodocs.dev/zh-hans/6.0/howto/custom-shell/","summary":"Django 的 shell 是一个交互式 Python 环境，它提供了对模型和设置的访问，使其适用于测试代码、尝试查询以及与应用程序数据交互。 自定义 shell 命令允许添加额外功能或预加载特定模块。要实现此功能，需新建一个继承自 django.core.management.commands.shell.Command…","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=\"/zh-hans/6.0/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=\"/zh-hans/6.0/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=\"/zh-hans/6.0/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=\"/zh-hans/6.0/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=\"/zh-hans/6.0/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=\"/zh-hans/6.0/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=\"/zh-hans/6.0/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\">verbosity=2</span></code> 参数运行此自定义的 <code class=\"docutils literal notranslate\"><span class=\"pre\">shell</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\">13 objects imported automatically:</span>\n\n<span class=\"go\">  from django.db import connection, reset_queries, models</span>\n<span class=\"go\">  from django.conf import settings</span>\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<span class=\"go\">  from django.utils import timezone</span>\n</code></pre></div>\n<aside class=\"version-note version-changed\" data-version=\"6.0\">\n<p class=\"version-note-title\">Changed in Django 6.0</p><p>添加了对常见工具（如 <code class=\"docutils literal notranslate\"><span class=\"pre\">django.conf.settings</span></code>）的自动导入功能。</p>\n</aside>\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=\"/zh-hans/6.0/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":"如何引导","url":"/zh-hans/6.0/howto/"}],"prev":{"docname":"howto/custom-management-commands","title":"编写自定义 django-admin 命令","url":"/zh-hans/6.0/howto/custom-management-commands/"},"next":{"docname":"faq/index","title":"Django FAQ","url":"/zh-hans/6.0/faq/"},"formats":{"html":"/zh-hans/6.0/howto/custom-shell/","markdown":"/zh-hans/6.0/howto/custom-shell.md","json":"/zh-hans/6.0/howto/custom-shell.json"},"source":"https://github.com/django/django/blob/stable/6.0.x/docs/howto/custom-shell.txt","official":"https://docs.djangoproject.com/zh-hans/6.0/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"]}