1. Randy Syring
  2. blaze-nose

Source

blaze-nose / doc / module_nose.config.html

<html>
  <head>
    <title>nose: nose.config</title>
    <link rel="stylesheet" href="site.css" type="text/css"></link>
  </head>
  <body>
    
    <div id="menu">
      <p>This document covers nose version <b>0.10.1</b></p>
      <p>Last update: <b>Fri Jan  4 10:06:23 2008</b></p>
      <h2>Plugins</h2><ul><li><a href="plugin_attrib.html">Builtin Plugin: attrib</a></li><li><a href="plugin_capture.html">Builtin Plugin: capture</a></li><li><a href="plugin_cover.html">Builtin Plugin: cover</a></li><li><a href="plugin_debug.html">Builtin Plugin: debug</a></li><li><a href="plugin_deprecated.html">Builtin Plugin: deprecated</a></li><li><a href="plugin_doctests.html">Builtin Plugin: doctests</a></li><li><a href="plugin_failuredetail.html">Builtin Plugin: failuredetail</a></li><li><a href="plugin_isolate.html">Builtin Plugin: isolate</a></li><li><a href="plugin_prof.html">Builtin Plugin: prof</a></li><li><a href="plugin_skip.html">Builtin Plugin: skip</a></li><li><a href="plugin_testid.html">Builtin Plugin: testid</a></li><li><a href="error_class_plugin.html">ErrorClass Plugins</a></li><li><a href="plugin_interface.html">Plugin Interface</a></li><li><a href="writing_plugins.html">Writing Plugins</a></li></ul><h2>Modules</h2><ul><li><a href="module_nose.case.html">Module: nose.case</a></li><li><a href="module_nose.commands.html">Module: nose.commands</a></li><li><a href="module_nose.config.html">Module: nose.config</a></li><li><a href="module_nose.core.html">Module: nose.core</a></li><li><a href="module_nose.exc.html">Module: nose.exc</a></li><li><a href="module_nose.importer.html">Module: nose.importer</a></li><li><a href="module_nose.inspector.html">Module: nose.inspector</a></li><li><a href="module_nose.loader.html">Module: nose.loader</a></li><li><a href="module_nose.plugins.manager.html">Module: nose.plugins.manager</a></li><li><a href="module_nose.plugins.plugintest.html">Module: nose.plugins.plugintest</a></li><li><a href="module_nose.proxy.html">Module: nose.proxy</a></li><li><a href="module_nose.result.html">Module: nose.result</a></li><li><a href="module_nose.selector.html">Module: nose.selector</a></li><li><a href="module_nose.suite.html">Module: nose.suite</a></li><li><a href="module_nose.tools.html">Module: nose.tools</a></li><li><a href="module_nose.twistedtools.html">Module: nose.twistedtools</a></li><li><a href="module_nose.util.html">Module: nose.util</a></li></ul><h2>Plugin Examples</h2><ul><li><a href="unwanted_package.html">Excluding Unwanted Packages</a></li><li><a href="empty_plugin.html">Minimal plugin</a></li><li><a href="init_plugin.html">Running Initialization Code Before the Test Run</a></li><li><a href="selector_plugin.html">Using a Custom Selector</a></li><li><a href="plugin_exceptions.html">When Plugins Fail</a></li><li><a href="plugintest_environment.html">nose.plugins.plugintest, os.environ and sys.argv</a></li></ul>
      <h2>Classes</h2><ul><li><a href="#NoOptions">NoOptions</a></li><li><a href="#NoPlugins">NoPlugins</a></li><li><a href="#Config">Config</a></li></ul><h2>Functions</h2><ul><li><a href="#user_config_files">user_config_files</a></li><li><a href="#flag">flag</a></li><li><a href="#all_config_files">all_config_files</a></li></ul><h2>Attributes</h2><ul><li><a href="#option_blacklist">option_blacklist</a></li><li><a href="#log">log</a></li><li><a href="#config_files">config_files</a></li></ul>
    </div>
    
    <div id="main">
      <h1>nose: nose.config</h1>
      
      <h2>Classes</h2>
<p>Highlighted methods are defined in this class.</p><a name="NoOptions"></a><div class="cls section"><span class="cls name">NoOptions</span> (object)<div class="cls doc"><p>Options container that returns None for all options.</p>
<h3>Methods</h3><div class="method section inherited"><span class="method name">__init__<span class="args">(...)</span></span><span class="method inherited">(inherited from object)</span><div class="method doc"><p>x.__init__(...) initializes x; see x.__class__.__doc__ for signature</p>
</div></div><div class="method section"><span class="method name">__nonzero__<span class="args">(self)</span></span><div class="method doc"></div></div></div></div>
<a name="NoPlugins"></a><div class="cls section"><span class="cls name">NoPlugins</span> (object)<div class="cls doc"><p>Plugin 'manager' that includes no plugins and returns None
for all calls</p>
<h3>Methods</h3><div class="method section"><span class="method name">__call__<span class="args">(self, *arg, **kw)</span></span><div class="method doc"></div></div><div class="method section inherited"><span class="method name">__init__<span class="args">(...)</span></span><span class="method inherited">(inherited from object)</span><div class="method doc"><p>x.__init__(...) initializes x; see x.__class__.__doc__ for signature</p>
</div></div></div></div>
<a name="Config"></a><div class="cls section"><span class="cls name">Config</span> (object)<div class="cls doc"><p>nose configuration.</p>
<p>Instances of Config are used throughout nose to configure
behavior, including plugin lists. Here are the default values for
all config keys:</p>
<pre class="literal-block">
self.env = env = kw.pop('env', {})
self.args = ()
self.testMatch = re.compile(r'(?:^|[\b_\.%s-])[Tt]est' % os.sep)
self.addPaths = not env.get('NOSE_NOPATH', False)
self.configSection = 'nosetests'
self.debug = env.get('NOSE_DEBUG')
self.debugLog = env.get('NOSE_DEBUG_LOG')
self.exclude = None
self.getTestCaseNamesCompat = False
self.includeExe = env.get('NOSE_INCLUDE_EXE',
                          sys.platform == 'win32')
self.ignoreFiles = (re.compile(r'^\.'),
                    re.compile(r'^_'),
                    re.compile(r'^setup\.py$')
                    )
self.include = None
self.loggingConfig = None
self.logStream = sys.stderr
self.options = NoOptions()
self.parser = None
self.plugins = NoPlugins()
self.srcDirs = ('lib', 'src')
self.runOnInit = True
self.stopOnError = env.get('NOSE_STOP', False)
self.stream = sys.stderr
self.testNames = ()
self.verbosity = int(env.get('NOSE_VERBOSE', 0))
self.where = ()
self.workingDir = None
</pre>
<h3>Methods</h3><div class="method section"><span class="method name">__init__<span class="args">(self, **kw)</span></span><div class="method doc"></div></div><div class="method section"><span class="method name">cfgToArg<span class="args">(self, optname, value, tr=None)</span></span><div class="method doc"></div></div><div class="method section"><span class="method name">configure<span class="args">(self, argv=None, doc=None)</span></span><div class="method doc"><p>Configure the nose running environment. Execute configure before
collecting tests with nose.TestCollector to enable output capture and
other features.</p>
</div></div><div class="method section"><span class="method name">configureLogging<span class="args">(self)</span></span><div class="method doc"><p>Configure logging for nose, or optionally other packages. Any logger
name may be set with the debug option, and that logger will be set to
debug level and be assigned the same handler as the nose loggers, unless
it already has a handler.</p>
</div></div><div class="method section"><span class="method name">configureWhere<span class="args">(self, where)</span></span><div class="method doc"><p>Configure the working directory or directories for the test run.</p>
</div></div><div class="method section"><span class="method name">default<span class="args">(self)</span></span><div class="method doc"><p>Reset all config values to defaults.</p>
</div></div><div class="method section"><span class="method name">getParser<span class="args">(self, doc=None)</span></span><div class="method doc"><p>Get the command line option parser.</p>
</div></div><div class="method section"><span class="method name">help<span class="args">(self, doc=None)</span></span><div class="method doc"><p>Return the generated help message</p>
</div></div><div class="method section"><span class="method name">loadConfig<span class="args">(self, file, argv)</span></span><div class="method doc"><p>Load config from file (may be filename or file-like object) and
push the config into argv.</p>
</div></div><div class="method section"><span class="method name">pluginOpts<span class="args">(self, parser)</span></span><div class="method doc"></div></div><div class="method section"><span class="method name">reset<span class="args">(self)</span></span><div class="method doc"></div></div><div class="method section"><span class="method name">todict<span class="args">(self)</span></span><div class="method doc"></div></div><div class="method section"><span class="method name">update<span class="args">(self, d)</span></span><div class="method doc"></div></div></div></div><h2>Functions</h2>
<a name="user_config_files"></a><div class="func section"><span class="func name">user_config_files<span class="args">()</span></span><div class="func doc"><p>Return path to any existing user config files</p>
</div></div>
<a name="flag"></a><div class="func section"><span class="func name">flag<span class="args">(val)</span></span><div class="func doc"><p>Does the value look like an on/off flag?</p>
</div></div>
<a name="all_config_files"></a><div class="func section"><span class="func name">all_config_files<span class="args">()</span></span><div class="func doc"><p>Return path to any existing user config files, plus any setup.cfg
in the current working directory.</p>
</div></div><h2>Attributes</h2>
<a name="option_blacklist"></a><div class="attr section"><span class="attr name">option_blacklist</span><pre class="attr value">Default value: [&#39;help&#39;, &#39;verbose&#39;]</pre><div class="attr doc"></div></div>
<a name="log"></a><div class="attr section"><span class="attr name">log</span><pre class="attr value">Default value: &lt;logging.Logger instance&gt;</pre><div class="attr doc"></div></div>
<a name="config_files"></a><div class="attr section"><span class="attr name">config_files</span><pre class="attr value">Default value: [&#39;~/.noserc&#39;, &#39;~/nose.cfg&#39;]</pre><div class="attr doc"></div></div>

    </div>
    <script src="http://www.google-analytics.com/urchin.js" 
	    type="text/javascript">
    </script>
    <script type="text/javascript">
      _uacct = "UA-2236166-1";
      urchinTracker();
    </script>
  </body>
</html>