<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>django.core.management — Django 1.6.7 documentation</title>
<link rel="stylesheet" href="../../../_static/default.css" type="text/css" />
<link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../../../',
VERSION: '1.6.7',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="../../../_static/jquery.js"></script>
<script type="text/javascript" src="../../../_static/underscore.js"></script>
<script type="text/javascript" src="../../../_static/doctools.js"></script>
<link rel="top" title="Django 1.6.7 documentation" href="../../../index.html" />
<link rel="up" title="Module code" href="../../index.html" />
<script type="text/javascript" src="../../../templatebuiltins.js"></script>
<script type="text/javascript">
(function($) {
if (!django_template_builtins) {
// templatebuiltins.js missing, do nothing.
return;
}
$(document).ready(function() {
// Hyperlink Django template tags and filters
var base = "../../../ref/templates/builtins.html";
if (base == "#") {
// Special case for builtins.html itself
base = "";
}
// Tags are keywords, class '.k'
$("div.highlight\\-html\\+django span.k").each(function(i, elem) {
var tagname = $(elem).text();
if ($.inArray(tagname, django_template_builtins.ttags) != -1) {
var fragment = tagname.replace(/_/, '-');
$(elem).html("<a href='" + base + "#" + fragment + "'>" + tagname + "</a>");
}
});
// Filters are functions, class '.nf'
$("div.highlight\\-html\\+django span.nf").each(function(i, elem) {
var filtername = $(elem).text();
if ($.inArray(filtername, django_template_builtins.tfilters) != -1) {
var fragment = filtername.replace(/_/, '-');
$(elem).html("<a href='" + base + "#" + fragment + "'>" + filtername + "</a>");
}
});
});
})(jQuery);
</script>
</head>
<body>
<div class="document">
<div id="custom-doc" class="yui-t6">
<div id="hd">
<h1><a href="../../../index.html">Django 1.6.7 documentation</a></h1>
<div id="global-nav">
<a title="Home page" href="../../../index.html">Home</a> |
<a title="Table of contents" href="../../../contents.html">Table of contents</a> |
<a title="Global index" href="../../../genindex.html">Index</a> |
<a title="Module index" href="../../../py-modindex.html">Modules</a>
</div>
<div class="nav">
<a href="../../index.html" title="Module code" accesskey="U">up</a></div>
</div>
<div id="bd">
<div id="yui-main">
<div class="yui-b">
<div class="yui-g" id="_modules-django-core-management">
<h1>Source code for django.core.management</h1><div class="highlight"><pre>
<span class="kn">import</span> <span class="nn">collections</span>
<span class="kn">import</span> <span class="nn">os</span>
<span class="kn">import</span> <span class="nn">sys</span>
<span class="kn">from</span> <span class="nn">optparse</span> <span class="kn">import</span> <span class="n">OptionParser</span><span class="p">,</span> <span class="n">NO_DEFAULT</span>
<span class="kn">import</span> <span class="nn">imp</span>
<span class="kn">from</span> <span class="nn">django.core.exceptions</span> <span class="kn">import</span> <span class="n">ImproperlyConfigured</span>
<span class="kn">from</span> <span class="nn">django.core.management.base</span> <span class="kn">import</span> <span class="n">BaseCommand</span><span class="p">,</span> <span class="n">CommandError</span><span class="p">,</span> <span class="n">handle_default_options</span>
<span class="kn">from</span> <span class="nn">django.core.management.color</span> <span class="kn">import</span> <span class="n">color_style</span>
<span class="kn">from</span> <span class="nn">django.utils.importlib</span> <span class="kn">import</span> <span class="n">import_module</span>
<span class="kn">from</span> <span class="nn">django.utils</span> <span class="kn">import</span> <span class="n">six</span>
<span class="c"># For backwards compatibility: get_version() used to be in this module.</span>
<span class="kn">from</span> <span class="nn">django</span> <span class="kn">import</span> <span class="n">get_version</span>
<span class="c"># A cache of loaded commands, so that call_command</span>
<span class="c"># doesn't have to reload every time it's called.</span>
<span class="n">_commands</span> <span class="o">=</span> <span class="bp">None</span>
<span class="k">def</span> <span class="nf">find_commands</span><span class="p">(</span><span class="n">management_dir</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Given a path to a management directory, returns a list of all the command</span>
<span class="sd"> names that are available.</span>
<span class="sd"> Returns an empty list if no commands are defined.</span>
<span class="sd"> """</span>
<span class="n">command_dir</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">management_dir</span><span class="p">,</span> <span class="s">'commands'</span><span class="p">)</span>
<span class="k">try</span><span class="p">:</span>
<span class="k">return</span> <span class="p">[</span><span class="n">f</span><span class="p">[:</span><span class="o">-</span><span class="mi">3</span><span class="p">]</span> <span class="k">for</span> <span class="n">f</span> <span class="ow">in</span> <span class="n">os</span><span class="o">.</span><span class="n">listdir</span><span class="p">(</span><span class="n">command_dir</span><span class="p">)</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">f</span><span class="o">.</span><span class="n">startswith</span><span class="p">(</span><span class="s">'_'</span><span class="p">)</span> <span class="ow">and</span> <span class="n">f</span><span class="o">.</span><span class="n">endswith</span><span class="p">(</span><span class="s">'.py'</span><span class="p">)]</span>
<span class="k">except</span> <span class="ne">OSError</span><span class="p">:</span>
<span class="k">return</span> <span class="p">[]</span>
<span class="k">def</span> <span class="nf">find_management_module</span><span class="p">(</span><span class="n">app_name</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Determines the path to the management module for the given app_name,</span>
<span class="sd"> without actually importing the application or the management module.</span>
<span class="sd"> Raises ImportError if the management module cannot be found for any reason.</span>
<span class="sd"> """</span>
<span class="n">parts</span> <span class="o">=</span> <span class="n">app_name</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s">'.'</span><span class="p">)</span>
<span class="n">parts</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s">'management'</span><span class="p">)</span>
<span class="n">parts</span><span class="o">.</span><span class="n">reverse</span><span class="p">()</span>
<span class="n">part</span> <span class="o">=</span> <span class="n">parts</span><span class="o">.</span><span class="n">pop</span><span class="p">()</span>
<span class="n">path</span> <span class="o">=</span> <span class="bp">None</span>
<span class="c"># When using manage.py, the project module is added to the path,</span>
<span class="c"># loaded, then removed from the path. This means that</span>
<span class="c"># testproject.testapp.models can be loaded in future, even if</span>
<span class="c"># testproject isn't in the path. When looking for the management</span>
<span class="c"># module, we need look for the case where the project name is part</span>
<span class="c"># of the app_name but the project directory itself isn't on the path.</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">f</span><span class="p">,</span> <span class="n">path</span><span class="p">,</span> <span class="n">descr</span> <span class="o">=</span> <span class="n">imp</span><span class="o">.</span><span class="n">find_module</span><span class="p">(</span><span class="n">part</span><span class="p">,</span> <span class="n">path</span><span class="p">)</span>
<span class="k">except</span> <span class="ne">ImportError</span> <span class="k">as</span> <span class="n">e</span><span class="p">:</span>
<span class="k">if</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">basename</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">getcwd</span><span class="p">())</span> <span class="o">!=</span> <span class="n">part</span><span class="p">:</span>
<span class="k">raise</span> <span class="n">e</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">if</span> <span class="n">f</span><span class="p">:</span>
<span class="n">f</span><span class="o">.</span><span class="n">close</span><span class="p">()</span>
<span class="k">while</span> <span class="n">parts</span><span class="p">:</span>
<span class="n">part</span> <span class="o">=</span> <span class="n">parts</span><span class="o">.</span><span class="n">pop</span><span class="p">()</span>
<span class="n">f</span><span class="p">,</span> <span class="n">path</span><span class="p">,</span> <span class="n">descr</span> <span class="o">=</span> <span class="n">imp</span><span class="o">.</span><span class="n">find_module</span><span class="p">(</span><span class="n">part</span><span class="p">,</span> <span class="p">[</span><span class="n">path</span><span class="p">]</span> <span class="k">if</span> <span class="n">path</span> <span class="k">else</span> <span class="bp">None</span><span class="p">)</span>
<span class="k">if</span> <span class="n">f</span><span class="p">:</span>
<span class="n">f</span><span class="o">.</span><span class="n">close</span><span class="p">()</span>
<span class="k">return</span> <span class="n">path</span>
<span class="k">def</span> <span class="nf">load_command_class</span><span class="p">(</span><span class="n">app_name</span><span class="p">,</span> <span class="n">name</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Given a command name and an application name, returns the Command</span>
<span class="sd"> class instance. All errors raised by the import process</span>
<span class="sd"> (ImportError, AttributeError) are allowed to propagate.</span>
<span class="sd"> """</span>
<span class="n">module</span> <span class="o">=</span> <span class="n">import_module</span><span class="p">(</span><span class="s">'</span><span class="si">%s</span><span class="s">.management.commands.</span><span class="si">%s</span><span class="s">'</span> <span class="o">%</span> <span class="p">(</span><span class="n">app_name</span><span class="p">,</span> <span class="n">name</span><span class="p">))</span>
<span class="k">return</span> <span class="n">module</span><span class="o">.</span><span class="n">Command</span><span class="p">()</span>
<span class="k">def</span> <span class="nf">get_commands</span><span class="p">():</span>
<span class="sd">"""</span>
<span class="sd"> Returns a dictionary mapping command names to their callback applications.</span>
<span class="sd"> This works by looking for a management.commands package in django.core, and</span>
<span class="sd"> in each installed application -- if a commands package exists, all commands</span>
<span class="sd"> in that package are registered.</span>
<span class="sd"> Core commands are always included. If a settings module has been</span>
<span class="sd"> specified, user-defined commands will also be included.</span>
<span class="sd"> The dictionary is in the format {command_name: app_name}. Key-value</span>
<span class="sd"> pairs from this dictionary can then be used in calls to</span>
<span class="sd"> load_command_class(app_name, command_name)</span>
<span class="sd"> If a specific version of a command must be loaded (e.g., with the</span>
<span class="sd"> startapp command), the instantiated module can be placed in the</span>
<span class="sd"> dictionary in place of the application name.</span>
<span class="sd"> The dictionary is cached on the first call and reused on subsequent</span>
<span class="sd"> calls.</span>
<span class="sd"> """</span>
<span class="k">global</span> <span class="n">_commands</span>
<span class="k">if</span> <span class="n">_commands</span> <span class="ow">is</span> <span class="bp">None</span><span class="p">:</span>
<span class="n">_commands</span> <span class="o">=</span> <span class="nb">dict</span><span class="p">([(</span><span class="n">name</span><span class="p">,</span> <span class="s">'django.core'</span><span class="p">)</span> <span class="k">for</span> <span class="n">name</span> <span class="ow">in</span> <span class="n">find_commands</span><span class="p">(</span><span class="n">__path__</span><span class="p">[</span><span class="mi">0</span><span class="p">])])</span>
<span class="c"># Find the installed apps</span>
<span class="kn">from</span> <span class="nn">django.conf</span> <span class="kn">import</span> <span class="n">settings</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">apps</span> <span class="o">=</span> <span class="n">settings</span><span class="o">.</span><span class="n">INSTALLED_APPS</span>
<span class="k">except</span> <span class="n">ImproperlyConfigured</span><span class="p">:</span>
<span class="c"># Still useful for commands that do not require functional settings,</span>
<span class="c"># like startproject or help</span>
<span class="n">apps</span> <span class="o">=</span> <span class="p">[]</span>
<span class="c"># Find and load the management module for each installed app.</span>
<span class="k">for</span> <span class="n">app_name</span> <span class="ow">in</span> <span class="n">apps</span><span class="p">:</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">path</span> <span class="o">=</span> <span class="n">find_management_module</span><span class="p">(</span><span class="n">app_name</span><span class="p">)</span>
<span class="n">_commands</span><span class="o">.</span><span class="n">update</span><span class="p">(</span><span class="nb">dict</span><span class="p">([(</span><span class="n">name</span><span class="p">,</span> <span class="n">app_name</span><span class="p">)</span>
<span class="k">for</span> <span class="n">name</span> <span class="ow">in</span> <span class="n">find_commands</span><span class="p">(</span><span class="n">path</span><span class="p">)]))</span>
<span class="k">except</span> <span class="ne">ImportError</span><span class="p">:</span>
<span class="k">pass</span> <span class="c"># No management module - ignore this app</span>
<span class="k">return</span> <span class="n">_commands</span>
<span class="k">def</span> <span class="nf">call_command</span><span class="p">(</span><span class="n">name</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">options</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Calls the given command, with the given options and args/kwargs.</span>
<span class="sd"> This is the primary API you should use for calling specific commands.</span>
<span class="sd"> Some examples:</span>
<span class="sd"> call_command('syncdb')</span>
<span class="sd"> call_command('shell', plain=True)</span>
<span class="sd"> call_command('sqlall', 'myapp')</span>
<span class="sd"> """</span>
<span class="c"># Load the command object.</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">app_name</span> <span class="o">=</span> <span class="n">get_commands</span><span class="p">()[</span><span class="n">name</span><span class="p">]</span>
<span class="k">except</span> <span class="ne">KeyError</span><span class="p">:</span>
<span class="k">raise</span> <span class="n">CommandError</span><span class="p">(</span><span class="s">"Unknown command: </span><span class="si">%r</span><span class="s">"</span> <span class="o">%</span> <span class="n">name</span><span class="p">)</span>
<span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">app_name</span><span class="p">,</span> <span class="n">BaseCommand</span><span class="p">):</span>
<span class="c"># If the command is already loaded, use it directly.</span>
<span class="n">klass</span> <span class="o">=</span> <span class="n">app_name</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">klass</span> <span class="o">=</span> <span class="n">load_command_class</span><span class="p">(</span><span class="n">app_name</span><span class="p">,</span> <span class="n">name</span><span class="p">)</span>
<span class="c"># Grab out a list of defaults from the options. optparse does this for us</span>
<span class="c"># when the script runs from the command line, but since call_command can</span>
<span class="c"># be called programatically, we need to simulate the loading and handling</span>
<span class="c"># of defaults (see #10080 for details).</span>
<span class="n">defaults</span> <span class="o">=</span> <span class="p">{}</span>
<span class="k">for</span> <span class="n">opt</span> <span class="ow">in</span> <span class="n">klass</span><span class="o">.</span><span class="n">option_list</span><span class="p">:</span>
<span class="k">if</span> <span class="n">opt</span><span class="o">.</span><span class="n">default</span> <span class="ow">is</span> <span class="n">NO_DEFAULT</span><span class="p">:</span>
<span class="n">defaults</span><span class="p">[</span><span class="n">opt</span><span class="o">.</span><span class="n">dest</span><span class="p">]</span> <span class="o">=</span> <span class="bp">None</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">defaults</span><span class="p">[</span><span class="n">opt</span><span class="o">.</span><span class="n">dest</span><span class="p">]</span> <span class="o">=</span> <span class="n">opt</span><span class="o">.</span><span class="n">default</span>
<span class="n">defaults</span><span class="o">.</span><span class="n">update</span><span class="p">(</span><span class="n">options</span><span class="p">)</span>
<span class="k">return</span> <span class="n">klass</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">defaults</span><span class="p">)</span>
<span class="k">class</span> <span class="nc">LaxOptionParser</span><span class="p">(</span><span class="n">OptionParser</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> An option parser that doesn't raise any errors on unknown options.</span>
<span class="sd"> This is needed because the --settings and --pythonpath options affect</span>
<span class="sd"> the commands (and thus the options) that are available to the user.</span>
<span class="sd"> """</span>
<span class="k">def</span> <span class="nf">error</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">msg</span><span class="p">):</span>
<span class="k">pass</span>
<span class="k">def</span> <span class="nf">print_help</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""Output nothing.</span>
<span class="sd"> The lax options are included in the normal option parser, so under</span>
<span class="sd"> normal usage, we don't need to print the lax options.</span>
<span class="sd"> """</span>
<span class="k">pass</span>
<span class="k">def</span> <span class="nf">print_lax_help</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""Output the basic options available to every command.</span>
<span class="sd"> This just redirects to the default print_help() behavior.</span>
<span class="sd"> """</span>
<span class="n">OptionParser</span><span class="o">.</span><span class="n">print_help</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">_process_args</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">largs</span><span class="p">,</span> <span class="n">rargs</span><span class="p">,</span> <span class="n">values</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Overrides OptionParser._process_args to exclusively handle default</span>
<span class="sd"> options and ignore args and other options.</span>
<span class="sd"> This overrides the behavior of the super class, which stop parsing</span>
<span class="sd"> at the first unrecognized option.</span>
<span class="sd"> """</span>
<span class="k">while</span> <span class="n">rargs</span><span class="p">:</span>
<span class="n">arg</span> <span class="o">=</span> <span class="n">rargs</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span>
<span class="k">try</span><span class="p">:</span>
<span class="k">if</span> <span class="n">arg</span><span class="p">[</span><span class="mi">0</span><span class="p">:</span><span class="mi">2</span><span class="p">]</span> <span class="o">==</span> <span class="s">"--"</span> <span class="ow">and</span> <span class="nb">len</span><span class="p">(</span><span class="n">arg</span><span class="p">)</span> <span class="o">></span> <span class="mi">2</span><span class="p">:</span>
<span class="c"># process a single long option (possibly with value(s))</span>
<span class="c"># the superclass code pops the arg off rargs</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_process_long_opt</span><span class="p">(</span><span class="n">rargs</span><span class="p">,</span> <span class="n">values</span><span class="p">)</span>
<span class="k">elif</span> <span class="n">arg</span><span class="p">[:</span><span class="mi">1</span><span class="p">]</span> <span class="o">==</span> <span class="s">"-"</span> <span class="ow">and</span> <span class="nb">len</span><span class="p">(</span><span class="n">arg</span><span class="p">)</span> <span class="o">></span> <span class="mi">1</span><span class="p">:</span>
<span class="c"># process a cluster of short options (possibly with</span>
<span class="c"># value(s) for the last one only)</span>
<span class="c"># the superclass code pops the arg off rargs</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_process_short_opts</span><span class="p">(</span><span class="n">rargs</span><span class="p">,</span> <span class="n">values</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="c"># it's either a non-default option or an arg</span>
<span class="c"># either way, add it to the args list so we can keep</span>
<span class="c"># dealing with options</span>
<span class="k">del</span> <span class="n">rargs</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span>
<span class="k">raise</span> <span class="ne">Exception</span>
<span class="k">except</span><span class="p">:</span>
<span class="n">largs</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">arg</span><span class="p">)</span>
<span class="k">class</span> <span class="nc">ManagementUtility</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Encapsulates the logic of the django-admin.py and manage.py utilities.</span>
<span class="sd"> A ManagementUtility has a number of commands, which can be manipulated</span>
<span class="sd"> by editing the self.commands dictionary.</span>
<span class="sd"> """</span>
<span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">argv</span><span class="o">=</span><span class="bp">None</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">argv</span> <span class="o">=</span> <span class="n">argv</span> <span class="ow">or</span> <span class="n">sys</span><span class="o">.</span><span class="n">argv</span><span class="p">[:]</span>
<span class="bp">self</span><span class="o">.</span><span class="n">prog_name</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">basename</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">argv</span><span class="p">[</span><span class="mi">0</span><span class="p">])</span>
<span class="k">def</span> <span class="nf">main_help_text</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">commands_only</span><span class="o">=</span><span class="bp">False</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Returns the script's main help text, as a string.</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="n">commands_only</span><span class="p">:</span>
<span class="n">usage</span> <span class="o">=</span> <span class="nb">sorted</span><span class="p">(</span><span class="n">get_commands</span><span class="p">()</span><span class="o">.</span><span class="n">keys</span><span class="p">())</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">usage</span> <span class="o">=</span> <span class="p">[</span>
<span class="s">""</span><span class="p">,</span>
<span class="s">"Type '</span><span class="si">%s</span><span class="s"> help <subcommand>' for help on a specific subcommand."</span> <span class="o">%</span> <span class="bp">self</span><span class="o">.</span><span class="n">prog_name</span><span class="p">,</span>
<span class="s">""</span><span class="p">,</span>
<span class="s">"Available subcommands:"</span><span class="p">,</span>
<span class="p">]</span>
<span class="n">commands_dict</span> <span class="o">=</span> <span class="n">collections</span><span class="o">.</span><span class="n">defaultdict</span><span class="p">(</span><span class="k">lambda</span><span class="p">:</span> <span class="p">[])</span>
<span class="k">for</span> <span class="n">name</span><span class="p">,</span> <span class="n">app</span> <span class="ow">in</span> <span class="n">six</span><span class="o">.</span><span class="n">iteritems</span><span class="p">(</span><span class="n">get_commands</span><span class="p">()):</span>
<span class="k">if</span> <span class="n">app</span> <span class="o">==</span> <span class="s">'django.core'</span><span class="p">:</span>
<span class="n">app</span> <span class="o">=</span> <span class="s">'django'</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">app</span> <span class="o">=</span> <span class="n">app</span><span class="o">.</span><span class="n">rpartition</span><span class="p">(</span><span class="s">'.'</span><span class="p">)[</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span>
<span class="n">commands_dict</span><span class="p">[</span><span class="n">app</span><span class="p">]</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">name</span><span class="p">)</span>
<span class="n">style</span> <span class="o">=</span> <span class="n">color_style</span><span class="p">()</span>
<span class="k">for</span> <span class="n">app</span> <span class="ow">in</span> <span class="nb">sorted</span><span class="p">(</span><span class="n">commands_dict</span><span class="o">.</span><span class="n">keys</span><span class="p">()):</span>
<span class="n">usage</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s">""</span><span class="p">)</span>
<span class="n">usage</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">style</span><span class="o">.</span><span class="n">NOTICE</span><span class="p">(</span><span class="s">"[</span><span class="si">%s</span><span class="s">]"</span> <span class="o">%</span> <span class="n">app</span><span class="p">))</span>
<span class="k">for</span> <span class="n">name</span> <span class="ow">in</span> <span class="nb">sorted</span><span class="p">(</span><span class="n">commands_dict</span><span class="p">[</span><span class="n">app</span><span class="p">]):</span>
<span class="n">usage</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s">" </span><span class="si">%s</span><span class="s">"</span> <span class="o">%</span> <span class="n">name</span><span class="p">)</span>
<span class="k">return</span> <span class="s">'</span><span class="se">\n</span><span class="s">'</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">usage</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">fetch_command</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">subcommand</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Tries to fetch the given subcommand, printing a message with the</span>
<span class="sd"> appropriate command called from the command line (usually</span>
<span class="sd"> "django-admin.py" or "manage.py") if it can't be found.</span>
<span class="sd"> """</span>
<span class="c"># Get commands outside of try block to prevent swallowing exceptions</span>
<span class="n">commands</span> <span class="o">=</span> <span class="n">get_commands</span><span class="p">()</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">app_name</span> <span class="o">=</span> <span class="n">commands</span><span class="p">[</span><span class="n">subcommand</span><span class="p">]</span>
<span class="k">except</span> <span class="ne">KeyError</span><span class="p">:</span>
<span class="n">sys</span><span class="o">.</span><span class="n">stderr</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s">"Unknown command: </span><span class="si">%r</span><span class="se">\n</span><span class="s">Type '</span><span class="si">%s</span><span class="s"> help' for usage.</span><span class="se">\n</span><span class="s">"</span> <span class="o">%</span> \
<span class="p">(</span><span class="n">subcommand</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">prog_name</span><span class="p">))</span>
<span class="n">sys</span><span class="o">.</span><span class="n">exit</span><span class="p">(</span><span class="mi">1</span><span class="p">)</span>
<span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">app_name</span><span class="p">,</span> <span class="n">BaseCommand</span><span class="p">):</span>
<span class="c"># If the command is already loaded, use it directly.</span>
<span class="n">klass</span> <span class="o">=</span> <span class="n">app_name</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">klass</span> <span class="o">=</span> <span class="n">load_command_class</span><span class="p">(</span><span class="n">app_name</span><span class="p">,</span> <span class="n">subcommand</span><span class="p">)</span>
<span class="k">return</span> <span class="n">klass</span>
<span class="k">def</span> <span class="nf">autocomplete</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Output completion suggestions for BASH.</span>
<span class="sd"> The output of this function is passed to BASH's `COMREPLY` variable and</span>
<span class="sd"> treated as completion suggestions. `COMREPLY` expects a space</span>
<span class="sd"> separated string as the result.</span>
<span class="sd"> The `COMP_WORDS` and `COMP_CWORD` BASH environment variables are used</span>
<span class="sd"> to get information about the cli input. Please refer to the BASH</span>
<span class="sd"> man-page for more information about this variables.</span>
<span class="sd"> Subcommand options are saved as pairs. A pair consists of</span>
<span class="sd"> the long option string (e.g. '--exclude') and a boolean</span>
<span class="sd"> value indicating if the option requires arguments. When printing to</span>
<span class="sd"> stdout, a equal sign is appended to options which require arguments.</span>
<span class="sd"> Note: If debugging this function, it is recommended to write the debug</span>
<span class="sd"> output in a separate file. Otherwise the debug output will be treated</span>
<span class="sd"> and formatted as potential completion suggestions.</span>
<span class="sd"> """</span>
<span class="c"># Don't complete if user hasn't sourced bash_completion file.</span>
<span class="k">if</span> <span class="s">'DJANGO_AUTO_COMPLETE'</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="p">:</span>
<span class="k">return</span>
<span class="n">cwords</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="p">[</span><span class="s">'COMP_WORDS'</span><span class="p">]</span><span class="o">.</span><span class="n">split</span><span class="p">()[</span><span class="mi">1</span><span class="p">:]</span>
<span class="n">cword</span> <span class="o">=</span> <span class="nb">int</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="p">[</span><span class="s">'COMP_CWORD'</span><span class="p">])</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">curr</span> <span class="o">=</span> <span class="n">cwords</span><span class="p">[</span><span class="n">cword</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span>
<span class="k">except</span> <span class="ne">IndexError</span><span class="p">:</span>
<span class="n">curr</span> <span class="o">=</span> <span class="s">''</span>
<span class="n">subcommands</span> <span class="o">=</span> <span class="nb">list</span><span class="p">(</span><span class="n">get_commands</span><span class="p">())</span> <span class="o">+</span> <span class="p">[</span><span class="s">'help'</span><span class="p">]</span>
<span class="n">options</span> <span class="o">=</span> <span class="p">[(</span><span class="s">'--help'</span><span class="p">,</span> <span class="bp">None</span><span class="p">)]</span>
<span class="c"># subcommand</span>
<span class="k">if</span> <span class="n">cword</span> <span class="o">==</span> <span class="mi">1</span><span class="p">:</span>
<span class="k">print</span><span class="p">(</span><span class="s">' '</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="nb">sorted</span><span class="p">(</span><span class="nb">filter</span><span class="p">(</span><span class="k">lambda</span> <span class="n">x</span><span class="p">:</span> <span class="n">x</span><span class="o">.</span><span class="n">startswith</span><span class="p">(</span><span class="n">curr</span><span class="p">),</span> <span class="n">subcommands</span><span class="p">))))</span>
<span class="c"># subcommand options</span>
<span class="c"># special case: the 'help' subcommand has no options</span>
<span class="k">elif</span> <span class="n">cwords</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="ow">in</span> <span class="n">subcommands</span> <span class="ow">and</span> <span class="n">cwords</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="o">!=</span> <span class="s">'help'</span><span class="p">:</span>
<span class="n">subcommand_cls</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">fetch_command</span><span class="p">(</span><span class="n">cwords</span><span class="p">[</span><span class="mi">0</span><span class="p">])</span>
<span class="c"># special case: 'runfcgi' stores additional options as</span>
<span class="c"># 'key=value' pairs</span>
<span class="k">if</span> <span class="n">cwords</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="o">==</span> <span class="s">'runfcgi'</span><span class="p">:</span>
<span class="kn">from</span> <span class="nn">django.core.servers.fastcgi</span> <span class="kn">import</span> <span class="n">FASTCGI_OPTIONS</span>
<span class="n">options</span> <span class="o">+=</span> <span class="p">[(</span><span class="n">k</span><span class="p">,</span> <span class="mi">1</span><span class="p">)</span> <span class="k">for</span> <span class="n">k</span> <span class="ow">in</span> <span class="n">FASTCGI_OPTIONS</span><span class="p">]</span>
<span class="c"># special case: add the names of installed apps to options</span>
<span class="k">elif</span> <span class="n">cwords</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="ow">in</span> <span class="p">(</span><span class="s">'dumpdata'</span><span class="p">,</span> <span class="s">'sql'</span><span class="p">,</span> <span class="s">'sqlall'</span><span class="p">,</span> <span class="s">'sqlclear'</span><span class="p">,</span>
<span class="s">'sqlcustom'</span><span class="p">,</span> <span class="s">'sqlindexes'</span><span class="p">,</span> <span class="s">'sqlsequencereset'</span><span class="p">,</span> <span class="s">'test'</span><span class="p">):</span>
<span class="k">try</span><span class="p">:</span>
<span class="kn">from</span> <span class="nn">django.conf</span> <span class="kn">import</span> <span class="n">settings</span>
<span class="c"># Get the last part of the dotted path as the app name.</span>
<span class="n">options</span> <span class="o">+=</span> <span class="p">[(</span><span class="n">a</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s">'.'</span><span class="p">)[</span><span class="o">-</span><span class="mi">1</span><span class="p">],</span> <span class="mi">0</span><span class="p">)</span> <span class="k">for</span> <span class="n">a</span> <span class="ow">in</span> <span class="n">settings</span><span class="o">.</span><span class="n">INSTALLED_APPS</span><span class="p">]</span>
<span class="k">except</span> <span class="ne">ImportError</span><span class="p">:</span>
<span class="c"># Fail silently if DJANGO_SETTINGS_MODULE isn't set. The</span>
<span class="c"># user will find out once they execute the command.</span>
<span class="k">pass</span>
<span class="n">options</span> <span class="o">+=</span> <span class="p">[(</span><span class="n">s_opt</span><span class="o">.</span><span class="n">get_opt_string</span><span class="p">(),</span> <span class="n">s_opt</span><span class="o">.</span><span class="n">nargs</span><span class="p">)</span> <span class="k">for</span> <span class="n">s_opt</span> <span class="ow">in</span>
<span class="n">subcommand_cls</span><span class="o">.</span><span class="n">option_list</span><span class="p">]</span>
<span class="c"># filter out previously specified options from available options</span>
<span class="n">prev_opts</span> <span class="o">=</span> <span class="p">[</span><span class="n">x</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s">'='</span><span class="p">)[</span><span class="mi">0</span><span class="p">]</span> <span class="k">for</span> <span class="n">x</span> <span class="ow">in</span> <span class="n">cwords</span><span class="p">[</span><span class="mi">1</span><span class="p">:</span><span class="n">cword</span><span class="o">-</span><span class="mi">1</span><span class="p">]]</span>
<span class="n">options</span> <span class="o">=</span> <span class="p">[</span><span class="n">opt</span> <span class="k">for</span> <span class="n">opt</span> <span class="ow">in</span> <span class="n">options</span> <span class="k">if</span> <span class="n">opt</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">prev_opts</span><span class="p">]</span>
<span class="c"># filter options by current input</span>
<span class="n">options</span> <span class="o">=</span> <span class="nb">sorted</span><span class="p">([(</span><span class="n">k</span><span class="p">,</span> <span class="n">v</span><span class="p">)</span> <span class="k">for</span> <span class="n">k</span><span class="p">,</span> <span class="n">v</span> <span class="ow">in</span> <span class="n">options</span> <span class="k">if</span> <span class="n">k</span><span class="o">.</span><span class="n">startswith</span><span class="p">(</span><span class="n">curr</span><span class="p">)])</span>
<span class="k">for</span> <span class="n">option</span> <span class="ow">in</span> <span class="n">options</span><span class="p">:</span>
<span class="n">opt_label</span> <span class="o">=</span> <span class="n">option</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span>
<span class="c"># append '=' to options which require args</span>
<span class="k">if</span> <span class="n">option</span><span class="p">[</span><span class="mi">1</span><span class="p">]:</span>
<span class="n">opt_label</span> <span class="o">+=</span> <span class="s">'='</span>
<span class="k">print</span><span class="p">(</span><span class="n">opt_label</span><span class="p">)</span>
<span class="n">sys</span><span class="o">.</span><span class="n">exit</span><span class="p">(</span><span class="mi">1</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">execute</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Given the command-line arguments, this figures out which subcommand is</span>
<span class="sd"> being run, creates a parser appropriate to that command, and runs it.</span>
<span class="sd"> """</span>
<span class="c"># Preprocess options to extract --settings and --pythonpath.</span>
<span class="c"># These options could affect the commands that are available, so they</span>
<span class="c"># must be processed early.</span>
<span class="n">parser</span> <span class="o">=</span> <span class="n">LaxOptionParser</span><span class="p">(</span><span class="n">usage</span><span class="o">=</span><span class="s">"%prog subcommand [options] [args]"</span><span class="p">,</span>
<span class="n">version</span><span class="o">=</span><span class="n">get_version</span><span class="p">(),</span>
<span class="n">option_list</span><span class="o">=</span><span class="n">BaseCommand</span><span class="o">.</span><span class="n">option_list</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">autocomplete</span><span class="p">()</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">options</span><span class="p">,</span> <span class="n">args</span> <span class="o">=</span> <span class="n">parser</span><span class="o">.</span><span class="n">parse_args</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">argv</span><span class="p">)</span>
<span class="n">handle_default_options</span><span class="p">(</span><span class="n">options</span><span class="p">)</span>
<span class="k">except</span><span class="p">:</span>
<span class="k">pass</span> <span class="c"># Ignore any option errors at this point.</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">subcommand</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">argv</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span>
<span class="k">except</span> <span class="ne">IndexError</span><span class="p">:</span>
<span class="n">subcommand</span> <span class="o">=</span> <span class="s">'help'</span> <span class="c"># Display help if no arguments were given.</span>
<span class="k">if</span> <span class="n">subcommand</span> <span class="o">==</span> <span class="s">'help'</span><span class="p">:</span>
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">args</span><span class="p">)</span> <span class="o"><=</span> <span class="mi">2</span><span class="p">:</span>
<span class="n">parser</span><span class="o">.</span><span class="n">print_lax_help</span><span class="p">()</span>
<span class="n">sys</span><span class="o">.</span><span class="n">stdout</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">main_help_text</span><span class="p">()</span> <span class="o">+</span> <span class="s">'</span><span class="se">\n</span><span class="s">'</span><span class="p">)</span>
<span class="k">elif</span> <span class="n">args</span><span class="p">[</span><span class="mi">2</span><span class="p">]</span> <span class="o">==</span> <span class="s">'--commands'</span><span class="p">:</span>
<span class="n">sys</span><span class="o">.</span><span class="n">stdout</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">main_help_text</span><span class="p">(</span><span class="n">commands_only</span><span class="o">=</span><span class="bp">True</span><span class="p">)</span> <span class="o">+</span> <span class="s">'</span><span class="se">\n</span><span class="s">'</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">fetch_command</span><span class="p">(</span><span class="n">args</span><span class="p">[</span><span class="mi">2</span><span class="p">])</span><span class="o">.</span><span class="n">print_help</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">prog_name</span><span class="p">,</span> <span class="n">args</span><span class="p">[</span><span class="mi">2</span><span class="p">])</span>
<span class="k">elif</span> <span class="n">subcommand</span> <span class="o">==</span> <span class="s">'version'</span><span class="p">:</span>
<span class="n">sys</span><span class="o">.</span><span class="n">stdout</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">parser</span><span class="o">.</span><span class="n">get_version</span><span class="p">()</span> <span class="o">+</span> <span class="s">'</span><span class="se">\n</span><span class="s">'</span><span class="p">)</span>
<span class="c"># Special-cases: We want 'django-admin.py --version' and</span>
<span class="c"># 'django-admin.py --help' to work, for backwards compatibility.</span>
<span class="k">elif</span> <span class="bp">self</span><span class="o">.</span><span class="n">argv</span><span class="p">[</span><span class="mi">1</span><span class="p">:]</span> <span class="o">==</span> <span class="p">[</span><span class="s">'--version'</span><span class="p">]:</span>
<span class="c"># LaxOptionParser already takes care of printing the version.</span>
<span class="k">pass</span>
<span class="k">elif</span> <span class="bp">self</span><span class="o">.</span><span class="n">argv</span><span class="p">[</span><span class="mi">1</span><span class="p">:]</span> <span class="ow">in</span> <span class="p">([</span><span class="s">'--help'</span><span class="p">],</span> <span class="p">[</span><span class="s">'-h'</span><span class="p">]):</span>
<span class="n">parser</span><span class="o">.</span><span class="n">print_lax_help</span><span class="p">()</span>
<span class="n">sys</span><span class="o">.</span><span class="n">stdout</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">main_help_text</span><span class="p">()</span> <span class="o">+</span> <span class="s">'</span><span class="se">\n</span><span class="s">'</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">fetch_command</span><span class="p">(</span><span class="n">subcommand</span><span class="p">)</span><span class="o">.</span><span class="n">run_from_argv</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">argv</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">execute_from_command_line</span><span class="p">(</span><span class="n">argv</span><span class="o">=</span><span class="bp">None</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> A simple method that runs a ManagementUtility.</span>
<span class="sd"> """</span>
<span class="n">utility</span> <span class="o">=</span> <span class="n">ManagementUtility</span><span class="p">(</span><span class="n">argv</span><span class="p">)</span>
<span class="n">utility</span><span class="o">.</span><span class="n">execute</span><span class="p">()</span>
</pre></div>
</div>
</div>
</div>
<div class="yui-b" id="sidebar">
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<h3>Browse</h3>
<ul>
</ul>
<h3>You are here:</h3>
<ul>
<li>
<a href="../../../index.html">Django 1.6.7 documentation</a>
<ul><li><a href="../../index.html">Module code</a>
<ul><li>django.core.management</li></ul>
</li></ul>
</li>
</ul>
<div id="searchbox" style="display: none">
<h3>Quick search</h3>
<form class="search" action="../../../search.html" method="get">
<input type="text" name="q" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
<p class="searchtip" style="font-size: 90%">
Enter search terms or a module, class or function name.
</p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<h3>Last update:</h3>
<p class="topless">Sep 26, 2014</p>
</div>
</div>
<div id="ft">
<div class="nav">
<a href="../../index.html" title="Module code" accesskey="U">up</a></div>
</div>
</div>
<div class="clearer"></div>
</div>
</body>
</html>
