<!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" lang="">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>unittest.loader — Django 1.8.19 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.8.19',
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="index" title="Index" href="../../genindex.html" />
<link rel="search" title="Search" href="../../search.html" />
<link rel="top" title="Django 1.8.19 documentation" href="../../contents.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 role="document">
<div class="document">
<div id="custom-doc" class="yui-t6">
<div id="hd">
<h1><a href="../../index.html">Django 1.8.19 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-unittest-loader">
<h1>Source code for unittest.loader</h1><div class="highlight"><pre>
<span></span><span class="sd">"""Loading unittests."""</span>
<span class="kn">import</span> <span class="nn">os</span>
<span class="kn">import</span> <span class="nn">re</span>
<span class="kn">import</span> <span class="nn">sys</span>
<span class="kn">import</span> <span class="nn">traceback</span>
<span class="kn">import</span> <span class="nn">types</span>
<span class="kn">from</span> <span class="nn">functools</span> <span class="k">import</span> <span class="n">cmp_to_key</span> <span class="k">as</span> <span class="n">_CmpToKey</span>
<span class="kn">from</span> <span class="nn">fnmatch</span> <span class="k">import</span> <span class="n">fnmatch</span>
<span class="kn">from</span> <span class="nn">.</span> <span class="k">import</span> <span class="n">case</span><span class="p">,</span> <span class="n">suite</span>
<span class="n">__unittest</span> <span class="o">=</span> <span class="kc">True</span>
<span class="c1"># what about .pyc or .pyo (etc)</span>
<span class="c1"># we would need to avoid loading the same tests multiple times</span>
<span class="c1"># from '.py', '.pyc' *and* '.pyo'</span>
<span class="n">VALID_MODULE_NAME</span> <span class="o">=</span> <span class="n">re</span><span class="o">.</span><span class="n">compile</span><span class="p">(</span><span class="s1">r'[_a-z]\w*\.py$'</span><span class="p">,</span> <span class="n">re</span><span class="o">.</span><span class="n">IGNORECASE</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">_make_failed_import_test</span><span class="p">(</span><span class="n">name</span><span class="p">,</span> <span class="n">suiteClass</span><span class="p">):</span>
<span class="n">message</span> <span class="o">=</span> <span class="s1">'Failed to import test module: </span><span class="si">%s</span><span class="se">\n</span><span class="si">%s</span><span class="s1">'</span> <span class="o">%</span> <span class="p">(</span><span class="n">name</span><span class="p">,</span> <span class="n">traceback</span><span class="o">.</span><span class="n">format_exc</span><span class="p">())</span>
<span class="k">return</span> <span class="n">_make_failed_test</span><span class="p">(</span><span class="s1">'ModuleImportFailure'</span><span class="p">,</span> <span class="n">name</span><span class="p">,</span> <span class="ne">ImportError</span><span class="p">(</span><span class="n">message</span><span class="p">),</span>
<span class="n">suiteClass</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">_make_failed_load_tests</span><span class="p">(</span><span class="n">name</span><span class="p">,</span> <span class="n">exception</span><span class="p">,</span> <span class="n">suiteClass</span><span class="p">):</span>
<span class="k">return</span> <span class="n">_make_failed_test</span><span class="p">(</span><span class="s1">'LoadTestsFailure'</span><span class="p">,</span> <span class="n">name</span><span class="p">,</span> <span class="n">exception</span><span class="p">,</span> <span class="n">suiteClass</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">_make_failed_test</span><span class="p">(</span><span class="n">classname</span><span class="p">,</span> <span class="n">methodname</span><span class="p">,</span> <span class="n">exception</span><span class="p">,</span> <span class="n">suiteClass</span><span class="p">):</span>
<span class="k">def</span> <span class="nf">testFailure</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="k">raise</span> <span class="n">exception</span>
<span class="n">attrs</span> <span class="o">=</span> <span class="p">{</span><span class="n">methodname</span><span class="p">:</span> <span class="n">testFailure</span><span class="p">}</span>
<span class="n">TestClass</span> <span class="o">=</span> <span class="nb">type</span><span class="p">(</span><span class="n">classname</span><span class="p">,</span> <span class="p">(</span><span class="n">case</span><span class="o">.</span><span class="n">TestCase</span><span class="p">,),</span> <span class="n">attrs</span><span class="p">)</span>
<span class="k">return</span> <span class="n">suiteClass</span><span class="p">((</span><span class="n">TestClass</span><span class="p">(</span><span class="n">methodname</span><span class="p">),))</span>
<span class="k">class</span> <span class="nc">TestLoader</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> This class is responsible for loading tests according to various criteria</span>
<span class="sd"> and returning them wrapped in a TestSuite</span>
<span class="sd"> """</span>
<span class="n">testMethodPrefix</span> <span class="o">=</span> <span class="s1">'test'</span>
<span class="n">sortTestMethodsUsing</span> <span class="o">=</span> <span class="nb">cmp</span>
<span class="n">suiteClass</span> <span class="o">=</span> <span class="n">suite</span><span class="o">.</span><span class="n">TestSuite</span>
<span class="n">_top_level_dir</span> <span class="o">=</span> <span class="kc">None</span>
<span class="k">def</span> <span class="nf">loadTestsFromTestCase</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">testCaseClass</span><span class="p">):</span>
<span class="sd">"""Return a suite of all tests cases contained in testCaseClass"""</span>
<span class="k">if</span> <span class="nb">issubclass</span><span class="p">(</span><span class="n">testCaseClass</span><span class="p">,</span> <span class="n">suite</span><span class="o">.</span><span class="n">TestSuite</span><span class="p">):</span>
<span class="k">raise</span> <span class="ne">TypeError</span><span class="p">(</span><span class="s2">"Test cases should not be derived from TestSuite."</span> \
<span class="s2">" Maybe you meant to derive from TestCase?"</span><span class="p">)</span>
<span class="n">testCaseNames</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">getTestCaseNames</span><span class="p">(</span><span class="n">testCaseClass</span><span class="p">)</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">testCaseNames</span> <span class="ow">and</span> <span class="nb">hasattr</span><span class="p">(</span><span class="n">testCaseClass</span><span class="p">,</span> <span class="s1">'runTest'</span><span class="p">):</span>
<span class="n">testCaseNames</span> <span class="o">=</span> <span class="p">[</span><span class="s1">'runTest'</span><span class="p">]</span>
<span class="n">loaded_suite</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">suiteClass</span><span class="p">(</span><span class="nb">map</span><span class="p">(</span><span class="n">testCaseClass</span><span class="p">,</span> <span class="n">testCaseNames</span><span class="p">))</span>
<span class="k">return</span> <span class="n">loaded_suite</span>
<span class="k">def</span> <span class="nf">loadTestsFromModule</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">module</span><span class="p">,</span> <span class="n">use_load_tests</span><span class="o">=</span><span class="kc">True</span><span class="p">):</span>
<span class="sd">"""Return a suite of all tests cases contained in the given module"""</span>
<span class="n">tests</span> <span class="o">=</span> <span class="p">[]</span>
<span class="k">for</span> <span class="n">name</span> <span class="ow">in</span> <span class="nb">dir</span><span class="p">(</span><span class="n">module</span><span class="p">):</span>
<span class="n">obj</span> <span class="o">=</span> <span class="nb">getattr</span><span class="p">(</span><span class="n">module</span><span class="p">,</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">obj</span><span class="p">,</span> <span class="nb">type</span><span class="p">)</span> <span class="ow">and</span> <span class="nb">issubclass</span><span class="p">(</span><span class="n">obj</span><span class="p">,</span> <span class="n">case</span><span class="o">.</span><span class="n">TestCase</span><span class="p">):</span>
<span class="n">tests</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">loadTestsFromTestCase</span><span class="p">(</span><span class="n">obj</span><span class="p">))</span>
<span class="n">load_tests</span> <span class="o">=</span> <span class="nb">getattr</span><span class="p">(</span><span class="n">module</span><span class="p">,</span> <span class="s1">'load_tests'</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span>
<span class="n">tests</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">suiteClass</span><span class="p">(</span><span class="n">tests</span><span class="p">)</span>
<span class="k">if</span> <span class="n">use_load_tests</span> <span class="ow">and</span> <span class="n">load_tests</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
<span class="k">try</span><span class="p">:</span>
<span class="k">return</span> <span class="n">load_tests</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">tests</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span>
<span class="k">except</span> <span class="ne">Exception</span><span class="p">,</span> <span class="n">e</span><span class="p">:</span>
<span class="k">return</span> <span class="n">_make_failed_load_tests</span><span class="p">(</span><span class="n">module</span><span class="o">.</span><span class="n">__name__</span><span class="p">,</span> <span class="n">e</span><span class="p">,</span>
<span class="bp">self</span><span class="o">.</span><span class="n">suiteClass</span><span class="p">)</span>
<span class="k">return</span> <span class="n">tests</span>
<span class="k">def</span> <span class="nf">loadTestsFromName</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">,</span> <span class="n">module</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="sd">"""Return a suite of all tests cases given a string specifier.</span>
<span class="sd"> The name may resolve either to a module, a test case class, a</span>
<span class="sd"> test method within a test case class, or a callable object which</span>
<span class="sd"> returns a TestCase or TestSuite instance.</span>
<span class="sd"> The method optionally resolves the names relative to a given module.</span>
<span class="sd"> """</span>
<span class="n">parts</span> <span class="o">=</span> <span class="n">name</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s1">'.'</span><span class="p">)</span>
<span class="k">if</span> <span class="n">module</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="n">parts_copy</span> <span class="o">=</span> <span class="n">parts</span><span class="p">[:]</span>
<span class="k">while</span> <span class="n">parts_copy</span><span class="p">:</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">module</span> <span class="o">=</span> <span class="nb">__import__</span><span class="p">(</span><span class="s1">'.'</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">parts_copy</span><span class="p">))</span>
<span class="k">break</span>
<span class="k">except</span> <span class="ne">ImportError</span><span class="p">:</span>
<span class="k">del</span> <span class="n">parts_copy</span><span class="p">[</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">parts_copy</span><span class="p">:</span>
<span class="k">raise</span>
<span class="n">parts</span> <span class="o">=</span> <span class="n">parts</span><span class="p">[</span><span class="mi">1</span><span class="p">:]</span>
<span class="n">obj</span> <span class="o">=</span> <span class="n">module</span>
<span class="k">for</span> <span class="n">part</span> <span class="ow">in</span> <span class="n">parts</span><span class="p">:</span>
<span class="n">parent</span><span class="p">,</span> <span class="n">obj</span> <span class="o">=</span> <span class="n">obj</span><span class="p">,</span> <span class="nb">getattr</span><span class="p">(</span><span class="n">obj</span><span class="p">,</span> <span class="n">part</span><span class="p">)</span>
<span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">obj</span><span class="p">,</span> <span class="n">types</span><span class="o">.</span><span class="n">ModuleType</span><span class="p">):</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">loadTestsFromModule</span><span class="p">(</span><span class="n">obj</span><span class="p">)</span>
<span class="k">elif</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">obj</span><span class="p">,</span> <span class="nb">type</span><span class="p">)</span> <span class="ow">and</span> <span class="nb">issubclass</span><span class="p">(</span><span class="n">obj</span><span class="p">,</span> <span class="n">case</span><span class="o">.</span><span class="n">TestCase</span><span class="p">):</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">loadTestsFromTestCase</span><span class="p">(</span><span class="n">obj</span><span class="p">)</span>
<span class="k">elif</span> <span class="p">(</span><span class="nb">isinstance</span><span class="p">(</span><span class="n">obj</span><span class="p">,</span> <span class="n">types</span><span class="o">.</span><span class="n">UnboundMethodType</span><span class="p">)</span> <span class="ow">and</span>
<span class="nb">isinstance</span><span class="p">(</span><span class="n">parent</span><span class="p">,</span> <span class="nb">type</span><span class="p">)</span> <span class="ow">and</span>
<span class="nb">issubclass</span><span class="p">(</span><span class="n">parent</span><span class="p">,</span> <span class="n">case</span><span class="o">.</span><span class="n">TestCase</span><span class="p">)):</span>
<span class="n">name</span> <span class="o">=</span> <span class="n">parts</span><span class="p">[</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span>
<span class="n">inst</span> <span class="o">=</span> <span class="n">parent</span><span class="p">(</span><span class="n">name</span><span class="p">)</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">suiteClass</span><span class="p">([</span><span class="n">inst</span><span class="p">])</span>
<span class="k">elif</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">obj</span><span class="p">,</span> <span class="n">suite</span><span class="o">.</span><span class="n">TestSuite</span><span class="p">):</span>
<span class="k">return</span> <span class="n">obj</span>
<span class="k">elif</span> <span class="nb">hasattr</span><span class="p">(</span><span class="n">obj</span><span class="p">,</span> <span class="s1">'__call__'</span><span class="p">):</span>
<span class="n">test</span> <span class="o">=</span> <span class="n">obj</span><span class="p">()</span>
<span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">test</span><span class="p">,</span> <span class="n">suite</span><span class="o">.</span><span class="n">TestSuite</span><span class="p">):</span>
<span class="k">return</span> <span class="n">test</span>
<span class="k">elif</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">test</span><span class="p">,</span> <span class="n">case</span><span class="o">.</span><span class="n">TestCase</span><span class="p">):</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">suiteClass</span><span class="p">([</span><span class="n">test</span><span class="p">])</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">TypeError</span><span class="p">(</span><span class="s2">"calling </span><span class="si">%s</span><span class="s2"> returned </span><span class="si">%s</span><span class="s2">, not a test"</span> <span class="o">%</span>
<span class="p">(</span><span class="n">obj</span><span class="p">,</span> <span class="n">test</span><span class="p">))</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">TypeError</span><span class="p">(</span><span class="s2">"don't know how to make test from: </span><span class="si">%s</span><span class="s2">"</span> <span class="o">%</span> <span class="n">obj</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">loadTestsFromNames</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">names</span><span class="p">,</span> <span class="n">module</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="sd">"""Return a suite of all tests cases found using the given sequence</span>
<span class="sd"> of string specifiers. See 'loadTestsFromName()'.</span>
<span class="sd"> """</span>
<span class="n">suites</span> <span class="o">=</span> <span class="p">[</span><span class="bp">self</span><span class="o">.</span><span class="n">loadTestsFromName</span><span class="p">(</span><span class="n">name</span><span class="p">,</span> <span class="n">module</span><span class="p">)</span> <span class="k">for</span> <span class="n">name</span> <span class="ow">in</span> <span class="n">names</span><span class="p">]</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">suiteClass</span><span class="p">(</span><span class="n">suites</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">getTestCaseNames</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">testCaseClass</span><span class="p">):</span>
<span class="sd">"""Return a sorted sequence of method names found within testCaseClass</span>
<span class="sd"> """</span>
<span class="k">def</span> <span class="nf">isTestMethod</span><span class="p">(</span><span class="n">attrname</span><span class="p">,</span> <span class="n">testCaseClass</span><span class="o">=</span><span class="n">testCaseClass</span><span class="p">,</span>
<span class="n">prefix</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">testMethodPrefix</span><span class="p">):</span>
<span class="k">return</span> <span class="n">attrname</span><span class="o">.</span><span class="n">startswith</span><span class="p">(</span><span class="n">prefix</span><span class="p">)</span> <span class="ow">and</span> \
<span class="nb">hasattr</span><span class="p">(</span><span class="nb">getattr</span><span class="p">(</span><span class="n">testCaseClass</span><span class="p">,</span> <span class="n">attrname</span><span class="p">),</span> <span class="s1">'__call__'</span><span class="p">)</span>
<span class="n">testFnNames</span> <span class="o">=</span> <span class="nb">filter</span><span class="p">(</span><span class="n">isTestMethod</span><span class="p">,</span> <span class="nb">dir</span><span class="p">(</span><span class="n">testCaseClass</span><span class="p">))</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">sortTestMethodsUsing</span><span class="p">:</span>
<span class="n">testFnNames</span><span class="o">.</span><span class="n">sort</span><span class="p">(</span><span class="n">key</span><span class="o">=</span><span class="n">_CmpToKey</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">sortTestMethodsUsing</span><span class="p">))</span>
<span class="k">return</span> <span class="n">testFnNames</span>
<span class="k">def</span> <span class="nf">discover</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">start_dir</span><span class="p">,</span> <span class="n">pattern</span><span class="o">=</span><span class="s1">'test*.py'</span><span class="p">,</span> <span class="n">top_level_dir</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="sd">"""Find and return all test modules from the specified start</span>
<span class="sd"> directory, recursing into subdirectories to find them. Only test files</span>
<span class="sd"> that match the pattern will be loaded. (Using shell style pattern</span>
<span class="sd"> matching.)</span>
<span class="sd"> All test modules must be importable from the top level of the project.</span>
<span class="sd"> If the start directory is not the top level directory then the top</span>
<span class="sd"> level directory must be specified separately.</span>
<span class="sd"> If a test package name (directory with '__init__.py') matches the</span>
<span class="sd"> pattern then the package will be checked for a 'load_tests' function. If</span>
<span class="sd"> this exists then it will be called with loader, tests, pattern.</span>
<span class="sd"> If load_tests exists then discovery does *not* recurse into the package,</span>
<span class="sd"> load_tests is responsible for loading all tests in the package.</span>
<span class="sd"> The pattern is deliberately not stored as a loader attribute so that</span>
<span class="sd"> packages can continue discovery themselves. top_level_dir is stored so</span>
<span class="sd"> load_tests does not need to pass this argument in to loader.discover().</span>
<span class="sd"> """</span>
<span class="n">set_implicit_top</span> <span class="o">=</span> <span class="kc">False</span>
<span class="k">if</span> <span class="n">top_level_dir</span> <span class="ow">is</span> <span class="kc">None</span> <span class="ow">and</span> <span class="bp">self</span><span class="o">.</span><span class="n">_top_level_dir</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
<span class="c1"># make top_level_dir optional if called from load_tests in a package</span>
<span class="n">top_level_dir</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_top_level_dir</span>
<span class="k">elif</span> <span class="n">top_level_dir</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="n">set_implicit_top</span> <span class="o">=</span> <span class="kc">True</span>
<span class="n">top_level_dir</span> <span class="o">=</span> <span class="n">start_dir</span>
<span class="n">top_level_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">abspath</span><span class="p">(</span><span class="n">top_level_dir</span><span class="p">)</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">top_level_dir</span> <span class="ow">in</span> <span class="n">sys</span><span class="o">.</span><span class="n">path</span><span class="p">:</span>
<span class="c1"># all test modules must be importable from the top level directory</span>
<span class="c1"># should we *unconditionally* put the start directory in first</span>
<span class="c1"># in sys.path to minimise likelihood of conflicts between installed</span>
<span class="c1"># modules and development versions?</span>
<span class="n">sys</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">insert</span><span class="p">(</span><span class="mi">0</span><span class="p">,</span> <span class="n">top_level_dir</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_top_level_dir</span> <span class="o">=</span> <span class="n">top_level_dir</span>
<span class="n">is_not_importable</span> <span class="o">=</span> <span class="kc">False</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">isdir</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">abspath</span><span class="p">(</span><span class="n">start_dir</span><span class="p">)):</span>
<span class="n">start_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">abspath</span><span class="p">(</span><span class="n">start_dir</span><span class="p">)</span>
<span class="k">if</span> <span class="n">start_dir</span> <span class="o">!=</span> <span class="n">top_level_dir</span><span class="p">:</span>
<span class="n">is_not_importable</span> <span class="o">=</span> <span class="ow">not</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">isfile</span><span class="p">(</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">start_dir</span><span class="p">,</span> <span class="s1">'__init__.py'</span><span class="p">))</span>
<span class="k">else</span><span class="p">:</span>
<span class="c1"># support for discovery from dotted module names</span>
<span class="k">try</span><span class="p">:</span>
<span class="nb">__import__</span><span class="p">(</span><span class="n">start_dir</span><span class="p">)</span>
<span class="k">except</span> <span class="ne">ImportError</span><span class="p">:</span>
<span class="n">is_not_importable</span> <span class="o">=</span> <span class="kc">True</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">the_module</span> <span class="o">=</span> <span class="n">sys</span><span class="o">.</span><span class="n">modules</span><span class="p">[</span><span class="n">start_dir</span><span class="p">]</span>
<span class="n">top_part</span> <span class="o">=</span> <span class="n">start_dir</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s1">'.'</span><span class="p">)[</span><span class="mi">0</span><span class="p">]</span>
<span class="n">start_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">abspath</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">dirname</span><span class="p">((</span><span class="n">the_module</span><span class="o">.</span><span class="n">__file__</span><span class="p">)))</span>
<span class="k">if</span> <span class="n">set_implicit_top</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_top_level_dir</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_get_directory_containing_module</span><span class="p">(</span><span class="n">top_part</span><span class="p">)</span>
<span class="n">sys</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">remove</span><span class="p">(</span><span class="n">top_level_dir</span><span class="p">)</span>
<span class="k">if</span> <span class="n">is_not_importable</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">ImportError</span><span class="p">(</span><span class="s1">'Start directory is not importable: </span><span class="si">%r</span><span class="s1">'</span> <span class="o">%</span> <span class="n">start_dir</span><span class="p">)</span>
<span class="n">tests</span> <span class="o">=</span> <span class="nb">list</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_find_tests</span><span class="p">(</span><span class="n">start_dir</span><span class="p">,</span> <span class="n">pattern</span><span class="p">))</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">suiteClass</span><span class="p">(</span><span class="n">tests</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">_get_directory_containing_module</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">module_name</span><span class="p">):</span>
<span class="n">module</span> <span class="o">=</span> <span class="n">sys</span><span class="o">.</span><span class="n">modules</span><span class="p">[</span><span class="n">module_name</span><span class="p">]</span>
<span class="n">full_path</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">abspath</span><span class="p">(</span><span class="n">module</span><span class="o">.</span><span class="n">__file__</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">full_path</span><span class="p">)</span><span class="o">.</span><span class="n">lower</span><span class="p">()</span><span class="o">.</span><span class="n">startswith</span><span class="p">(</span><span class="s1">'__init__.py'</span><span class="p">):</span>
<span class="k">return</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">dirname</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">dirname</span><span class="p">(</span><span class="n">full_path</span><span class="p">))</span>
<span class="k">else</span><span class="p">:</span>
<span class="c1"># here we have been given a module rather than a package - so</span>
<span class="c1"># all we can do is search the *same* directory the module is in</span>
<span class="c1"># should an exception be raised instead</span>
<span class="k">return</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">dirname</span><span class="p">(</span><span class="n">full_path</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">_get_name_from_path</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">path</span><span class="p">):</span>
<span class="n">path</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">splitext</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">normpath</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="n">_relpath</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">relpath</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">_top_level_dir</span><span class="p">)</span>
<span class="k">assert</span> <span class="ow">not</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">isabs</span><span class="p">(</span><span class="n">_relpath</span><span class="p">),</span> <span class="s2">"Path must be within the project"</span>
<span class="k">assert</span> <span class="ow">not</span> <span class="n">_relpath</span><span class="o">.</span><span class="n">startswith</span><span class="p">(</span><span class="s1">'..'</span><span class="p">),</span> <span class="s2">"Path must be within the project"</span>
<span class="n">name</span> <span class="o">=</span> <span class="n">_relpath</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">sep</span><span class="p">,</span> <span class="s1">'.'</span><span class="p">)</span>
<span class="k">return</span> <span class="n">name</span>
<span class="k">def</span> <span class="nf">_get_module_from_name</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">):</span>
<span class="nb">__import__</span><span class="p">(</span><span class="n">name</span><span class="p">)</span>
<span class="k">return</span> <span class="n">sys</span><span class="o">.</span><span class="n">modules</span><span class="p">[</span><span class="n">name</span><span class="p">]</span>
<span class="k">def</span> <span class="nf">_match_path</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">path</span><span class="p">,</span> <span class="n">full_path</span><span class="p">,</span> <span class="n">pattern</span><span class="p">):</span>
<span class="c1"># override this method to use alternative matching strategy</span>
<span class="k">return</span> <span class="n">fnmatch</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="n">pattern</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">_find_tests</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">start_dir</span><span class="p">,</span> <span class="n">pattern</span><span class="p">):</span>
<span class="sd">"""Used by discovery. Yields test suites it loads."""</span>
<span class="n">paths</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">listdir</span><span class="p">(</span><span class="n">start_dir</span><span class="p">)</span>
<span class="k">for</span> <span class="n">path</span> <span class="ow">in</span> <span class="n">paths</span><span class="p">:</span>
<span class="n">full_path</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">start_dir</span><span class="p">,</span> <span class="n">path</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">isfile</span><span class="p">(</span><span class="n">full_path</span><span class="p">):</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">VALID_MODULE_NAME</span><span class="o">.</span><span class="n">match</span><span class="p">(</span><span class="n">path</span><span class="p">):</span>
<span class="c1"># valid Python identifiers only</span>
<span class="k">continue</span>
<span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">_match_path</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="n">full_path</span><span class="p">,</span> <span class="n">pattern</span><span class="p">):</span>
<span class="k">continue</span>
<span class="c1"># if the test file matches, load it</span>
<span class="n">name</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_get_name_from_path</span><span class="p">(</span><span class="n">full_path</span><span class="p">)</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">module</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_get_module_from_name</span><span class="p">(</span><span class="n">name</span><span class="p">)</span>
<span class="k">except</span><span class="p">:</span>
<span class="k">yield</span> <span class="n">_make_failed_import_test</span><span class="p">(</span><span class="n">name</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">suiteClass</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">mod_file</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">abspath</span><span class="p">(</span><span class="nb">getattr</span><span class="p">(</span><span class="n">module</span><span class="p">,</span> <span class="s1">'__file__'</span><span class="p">,</span> <span class="n">full_path</span><span class="p">))</span>
<span class="n">realpath</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">splitext</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">realpath</span><span class="p">(</span><span class="n">mod_file</span><span class="p">))[</span><span class="mi">0</span><span class="p">]</span>
<span class="n">fullpath_noext</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">splitext</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">realpath</span><span class="p">(</span><span class="n">full_path</span><span class="p">))[</span><span class="mi">0</span><span class="p">]</span>
<span class="k">if</span> <span class="n">realpath</span><span class="o">.</span><span class="n">lower</span><span class="p">()</span> <span class="o">!=</span> <span class="n">fullpath_noext</span><span class="o">.</span><span class="n">lower</span><span class="p">():</span>
<span class="n">module_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">dirname</span><span class="p">(</span><span class="n">realpath</span><span class="p">)</span>
<span class="n">mod_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">splitext</span><span class="p">(</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">full_path</span><span class="p">))[</span><span class="mi">0</span><span class="p">]</span>
<span class="n">expected_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">dirname</span><span class="p">(</span><span class="n">full_path</span><span class="p">)</span>
<span class="n">msg</span> <span class="o">=</span> <span class="p">(</span><span class="s2">"</span><span class="si">%r</span><span class="s2"> module incorrectly imported from </span><span class="si">%r</span><span class="s2">. Expected </span><span class="si">%r</span><span class="s2">. "</span>
<span class="s2">"Is this module globally installed?"</span><span class="p">)</span>
<span class="k">raise</span> <span class="ne">ImportError</span><span class="p">(</span><span class="n">msg</span> <span class="o">%</span> <span class="p">(</span><span class="n">mod_name</span><span class="p">,</span> <span class="n">module_dir</span><span class="p">,</span> <span class="n">expected_dir</span><span class="p">))</span>
<span class="k">yield</span> <span class="bp">self</span><span class="o">.</span><span class="n">loadTestsFromModule</span><span class="p">(</span><span class="n">module</span><span class="p">)</span>
<span class="k">elif</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">isdir</span><span class="p">(</span><span class="n">full_path</span><span class="p">):</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">isfile</span><span class="p">(</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">full_path</span><span class="p">,</span> <span class="s1">'__init__.py'</span><span class="p">)):</span>
<span class="k">continue</span>
<span class="n">load_tests</span> <span class="o">=</span> <span class="kc">None</span>
<span class="n">tests</span> <span class="o">=</span> <span class="kc">None</span>
<span class="k">if</span> <span class="n">fnmatch</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="n">pattern</span><span class="p">):</span>
<span class="c1"># only check load_tests if the package directory itself matches the filter</span>
<span class="n">name</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_get_name_from_path</span><span class="p">(</span><span class="n">full_path</span><span class="p">)</span>
<span class="n">package</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_get_module_from_name</span><span class="p">(</span><span class="n">name</span><span class="p">)</span>
<span class="n">load_tests</span> <span class="o">=</span> <span class="nb">getattr</span><span class="p">(</span><span class="n">package</span><span class="p">,</span> <span class="s1">'load_tests'</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span>
<span class="n">tests</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">loadTestsFromModule</span><span class="p">(</span><span class="n">package</span><span class="p">,</span> <span class="n">use_load_tests</span><span class="o">=</span><span class="kc">False</span><span class="p">)</span>
<span class="k">if</span> <span class="n">load_tests</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="k">if</span> <span class="n">tests</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
<span class="c1"># tests loaded from package file</span>
<span class="k">yield</span> <span class="n">tests</span>
<span class="c1"># recurse into the package</span>
<span class="k">for</span> <span class="n">test</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">_find_tests</span><span class="p">(</span><span class="n">full_path</span><span class="p">,</span> <span class="n">pattern</span><span class="p">):</span>
<span class="k">yield</span> <span class="n">test</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">try</span><span class="p">:</span>
<span class="k">yield</span> <span class="n">load_tests</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">tests</span><span class="p">,</span> <span class="n">pattern</span><span class="p">)</span>
<span class="k">except</span> <span class="ne">Exception</span><span class="p">,</span> <span class="n">e</span><span class="p">:</span>
<span class="k">yield</span> <span class="n">_make_failed_load_tests</span><span class="p">(</span><span class="n">package</span><span class="o">.</span><span class="n">__name__</span><span class="p">,</span> <span class="n">e</span><span class="p">,</span>
<span class="bp">self</span><span class="o">.</span><span class="n">suiteClass</span><span class="p">)</span>
<span class="n">defaultTestLoader</span> <span class="o">=</span> <span class="n">TestLoader</span><span class="p">()</span>
<span class="k">def</span> <span class="nf">_makeLoader</span><span class="p">(</span><span class="n">prefix</span><span class="p">,</span> <span class="n">sortUsing</span><span class="p">,</span> <span class="n">suiteClass</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="n">loader</span> <span class="o">=</span> <span class="n">TestLoader</span><span class="p">()</span>
<span class="n">loader</span><span class="o">.</span><span class="n">sortTestMethodsUsing</span> <span class="o">=</span> <span class="n">sortUsing</span>
<span class="n">loader</span><span class="o">.</span><span class="n">testMethodPrefix</span> <span class="o">=</span> <span class="n">prefix</span>
<span class="k">if</span> <span class="n">suiteClass</span><span class="p">:</span>
<span class="n">loader</span><span class="o">.</span><span class="n">suiteClass</span> <span class="o">=</span> <span class="n">suiteClass</span>
<span class="k">return</span> <span class="n">loader</span>
<span class="k">def</span> <span class="nf">getTestCaseNames</span><span class="p">(</span><span class="n">testCaseClass</span><span class="p">,</span> <span class="n">prefix</span><span class="p">,</span> <span class="n">sortUsing</span><span class="o">=</span><span class="nb">cmp</span><span class="p">):</span>
<span class="k">return</span> <span class="n">_makeLoader</span><span class="p">(</span><span class="n">prefix</span><span class="p">,</span> <span class="n">sortUsing</span><span class="p">)</span><span class="o">.</span><span class="n">getTestCaseNames</span><span class="p">(</span><span class="n">testCaseClass</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">makeSuite</span><span class="p">(</span><span class="n">testCaseClass</span><span class="p">,</span> <span class="n">prefix</span><span class="o">=</span><span class="s1">'test'</span><span class="p">,</span> <span class="n">sortUsing</span><span class="o">=</span><span class="nb">cmp</span><span class="p">,</span>
<span class="n">suiteClass</span><span class="o">=</span><span class="n">suite</span><span class="o">.</span><span class="n">TestSuite</span><span class="p">):</span>
<span class="k">return</span> <span class="n">_makeLoader</span><span class="p">(</span><span class="n">prefix</span><span class="p">,</span> <span class="n">sortUsing</span><span class="p">,</span> <span class="n">suiteClass</span><span class="p">)</span><span class="o">.</span><span class="n">loadTestsFromTestCase</span><span class="p">(</span><span class="n">testCaseClass</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">findTestCases</span><span class="p">(</span><span class="n">module</span><span class="p">,</span> <span class="n">prefix</span><span class="o">=</span><span class="s1">'test'</span><span class="p">,</span> <span class="n">sortUsing</span><span class="o">=</span><span class="nb">cmp</span><span class="p">,</span>
<span class="n">suiteClass</span><span class="o">=</span><span class="n">suite</span><span class="o">.</span><span class="n">TestSuite</span><span class="p">):</span>
<span class="k">return</span> <span class="n">_makeLoader</span><span class="p">(</span><span class="n">prefix</span><span class="p">,</span> <span class="n">sortUsing</span><span class="p">,</span> <span class="n">suiteClass</span><span class="p">)</span><span class="o">.</span><span class="n">loadTestsFromModule</span><span class="p">(</span><span class="n">module</span><span class="p">)</span>
</pre></div>
</div>
</div>
</div>
<div class="yui-b" id="sidebar">
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<h3>Browse</h3>
<ul>
</ul>
<h3>You are here:</h3>
<ul>
<li>
<a href="../../index.html">Django 1.8.19 documentation</a>
<ul><li><a href="../index.html">Module code</a>
<ul><li>unittest.loader</li></ul>
</li></ul>
</li>
</ul>
<div id="searchbox" style="display: none" role="search">
<h3>Quick search</h3>
<form class="search" action="../../search.html" method="get">
<div><input type="text" name="q" /></div>
<div><input type="submit" value="Go" /></div>
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<h3>Last update:</h3>
<p class="topless">Mar 10, 2018</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>
