bootstraparse/apidoc/bootstraparse.modules.envir...

539 lines
16 KiB
HTML

<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
"DTD/xhtml1-strict.dtd">
<html>
<head>
<title>bootstraparse.modules.environment.Environment</title>
<meta name="generator" content="pydoctor 22.5.1">
</meta>
<meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1 maximum-scale=1" />
<link rel="stylesheet" type="text/css" href="bootstrap.min.css" />
<link rel="stylesheet" type="text/css" href="apidocs.css" />
<link rel="stylesheet" type="text/css" href="extra.css" />
</head>
<body>
<nav class="navbar navbar-default mainnavbar">
<div class="container-fluid">
<div class="navbar-header">
<div class="navlinks">
<span class="navbar-brand">
bootstraparse <a href="index.html">API Documentation</a>
</span>
<a href="moduleIndex.html">
Modules
</a>
<a href="classIndex.html">
Classes
</a>
<a href="nameIndex.html">
Names
</a>
<div id="search-box-container">
<div class="input-group">
<input id="search-box" type="search" name="search-query" placeholder="Search..." aria-label="Search" minlength="2" class="form-control" autocomplete="off" />
<span class="input-group-btn">
<a style="display: none;" class="btn btn-default" id="search-clear-button" title="Clear" onclick="clearSearch()"><img src="fonts/x-circle.svg" alt="Clear" /></a>
<a class="btn btn-default" id="search-help-button" title="Help" onclick="toggleSearchHelpText()"><img src="fonts/info.svg" alt="Help" /></a>
</span>
</div>
</div>
</div>
<div id="search-results-container" style="display: none;">
<div id="search-buttons">
<span class="label label-default" id="search-docstrings-button">
<label class="checkbox-inline">
<input type="checkbox" id="toggle-search-in-docstrings-checkbox" value="false" onclick="toggleSearchInDocstrings()">
search in docstrings
</input>
</label>
</span>
</div>
<noscript>
<h1>Cannot search: JavaScript is not supported/enabled in your browser.</h1>
</noscript>
<div class="hint" id="search-help-box">
<p class="rst-last">
Search bar offers the following options:
<ul>
<li>
<strong>Term presence.</strong> The below example searches for documents that
must contain “foo”, might contain “bar” and must not contain “baz”: <code>+foo bar -baz</code>
</li>
<li>
<strong>Wildcards.</strong> The below example searches for documents with words beginning with “foo”: <code>foo*</code>
</li>
<li>
<strong>Search in specific fields.</strong> The following search matches all objects
in "twisted.mail" that matches “search”: <code>+qname:twisted.mail.* +search</code>
<p>
Possible fields: 'name', 'qname' (fully qualified name), 'docstring', and 'kind'.
Last two fields are only applicable if "search in docstrings" is enabled.
</p>
</li>
<li>
<strong>Fuzzy matches.</strong> The following search matches all documents
that have a word within 1 edit distance of “foo”: <code>foo~1</code>
</li>
</ul>
</p>
</div>
<div id="search-status"> </div>
<div class="warning" id="search-warn-box" style="display: none;">
<p class="rst-last"><span id="search-warn"></span></p>
</div>
<table id="search-results">
<!-- Filled dynamically by JS -->
</table>
<div style="margin-top: 8px;">
<p>Results provided by <a href="https://lunrjs.com">Lunr.js</a></p>
</div>
</div>
</div>
</div>
</nav>
<div class="container-fluid">
<!-- Side navigation -->
<div class="sidebarcontainer" style="display: none;">
<div class="sidebar"><nav class="sidebar">
<div>
<div class="thingTitle">
<span>Class</span>
<code class="thisobject"><a href="bootstraparse.modules.environment.Environment.html" class="internal-link" title="This class"><wbr></wbr>Environment</a></code>
</div>
<div>
<div class="childrenKindTitle">Methods</div>
<ul>
<li class="">
<div class="itemName"><code><a href="#__getattr__" class="internal-link" title="bootstraparse.modules.environment.Environment.__getattr__">__getattr__</a></code>
</div>
</li><li class="">
<div class="itemName"><code><a href="#__init__" class="internal-link" title="bootstraparse.modules.environment.Environment.__init__">__init__</a></code>
</div>
</li><li class="">
<div class="itemName"><code><a href="#__setattr__" class="internal-link" title="bootstraparse.modules.environment.Environment.__setattr__">__setattr__</a></code>
</div>
</li><li class="">
<div class="itemName"><code><a href="#integrity_check" class="internal-link" title="bootstraparse.modules.environment.Environment.integrity_check">integrity<wbr></wbr>_check</a></code>
</div>
</li>
</ul>
<div class="childrenKindTitle">Attributes</div>
<ul>
<li class="private">
<div class="itemName"><code><a href="#_mParams" class="internal-link" title="bootstraparse.modules.environment.Environment._mParams">_m<wbr></wbr>Params</a></code>
</div>
</li><li class="private">
<div class="itemName"><code><a href="#_sParams" class="internal-link" title="bootstraparse.modules.environment.Environment._sParams">_s<wbr></wbr>Params</a></code>
</div>
</li><li class="private">
<div class="itemName"><code><a href="#_wasInitialised" class="internal-link" title="bootstraparse.modules.environment.Environment._wasInitialised">_was<wbr></wbr>Initialised</a></code>
</div>
</li>
</ul>
</div>
</div><div>
<div class="thingTitle">
<span>Module</span>
<code><a href="bootstraparse.modules.environment.html" class="internal-link" title="The parent of this class">environment</a></code>
</div>
<div>
<div class="childrenKindTitle">Classes</div>
<ul>
<li class=" thisobject">
<div class="itemName"><code><a href="bootstraparse.modules.environment.Environment.html" class="internal-link" title="bootstraparse.modules.environment.Environment"><wbr></wbr>Environment</a></code>
</div>
</li>
</ul>
</div>
</div>
</nav>
</div>
<div id="collapseSideBar">
<a class="btn btn-link" onclick="toggleSideBarCollapse()" title="Toggle Sidebar Collapse">
</a>
</div>
<script src="sidebartoggle.js" type="text/javascript"></script>
</div>
<div id="main" class="">
<div class="page-header">
<h1 class="class"><code><code><a href="index.html" class="internal-link">bootstraparse</a></code><wbr></wbr>.<code><a href="bootstraparse.modules.html" class="internal-link" title="bootstraparse.modules">modules</a></code><wbr></wbr>.<code><a href="bootstraparse.modules.environment.html" class="internal-link" title="bootstraparse.modules.environment">environment</a></code><wbr></wbr>.<code><a href="bootstraparse.modules.environment.Environment.html" class="internal-link" title="bootstraparse.modules.environment.Environment">Environment</a></code></code></h1>
<div id="showPrivate">
<button class="btn btn-link" onclick="togglePrivate()">Toggle Private API</button>
</div>
</div>
<div class="categoryHeader">
class documentation
</div>
<div class="extrasDocstring">
<p><code><span class="py-keyword">class</span> <span class="py-defname">Environment</span>:</code></p>
<p><a href="classIndex.html#bootstraparse.modules.environment.Environment">View In Hierarchy</a></p>
</div>
<div class="moduleDocstring">
<div><p>Object containing all the important variables, with appropriate getters and setters. Also contains self integrity checks.</p>
</div>
</div>
<div id="splitTables">
<table class="children sortable" id="id45">
<tr class="method">
<td>Method</td>
<td><code><a href="#__getattr__" class="internal-link" title="bootstraparse.modules.environment.Environment.__getattr__">__getattr__</a></code></td>
<td>Getter for all parameters, looks for super if the parameter is prefaced with an underscore. Looks for mandatory parameters first, then secondary parameters. :param attribute: The name of the parameter to get...</td>
</tr><tr class="method">
<td>Method</td>
<td><code><a href="#__init__" class="internal-link" title="bootstraparse.modules.environment.Environment.__init__">__init__</a></code></td>
<td>Initialises the environment, all parameters are set to None. Set _wasInitialised to False for all parameters.</td>
</tr><tr class="method">
<td>Method</td>
<td><code><a href="#__setattr__" class="internal-link" title="bootstraparse.modules.environment.Environment.__setattr__">__setattr__</a></code></td>
<td>Setter for all parameters, looks for super if the parameter is prefaced with an underscore. :param attribute: The name of the parameter to set. :type attribute: str</td>
</tr><tr class="method">
<td>Method</td>
<td><code><a href="#integrity_check" class="internal-link" title="bootstraparse.modules.environment.Environment.integrity_check">integrity<wbr></wbr>_check</a></code></td>
<td>Checks if all mandatory parameters are set. :return: True if all mandatory parameters are set, False otherwise.</td>
</tr><tr class="instancevariable private">
<td>Instance Variable</td>
<td><code><a href="#_mParams" class="internal-link" title="bootstraparse.modules.environment.Environment._mParams">_m<wbr></wbr>Params</a></code></td>
<td><span class="undocumented">Undocumented</span></td>
</tr><tr class="instancevariable private">
<td>Instance Variable</td>
<td><code><a href="#_sParams" class="internal-link" title="bootstraparse.modules.environment.Environment._sParams">_s<wbr></wbr>Params</a></code></td>
<td><span class="undocumented">Undocumented</span></td>
</tr><tr class="instancevariable private">
<td>Instance Variable</td>
<td><code><a href="#_wasInitialised" class="internal-link" title="bootstraparse.modules.environment.Environment._wasInitialised">_was<wbr></wbr>Initialised</a></code></td>
<td><span class="undocumented">Undocumented</span></td>
</tr>
</table>
</div>
<div id="childList">
<div class="basemethod">
<a name="bootstraparse.modules.environment.Environment.__getattr__">
</a>
<a name="__getattr__">
</a>
<div class="functionHeader">
<span class="py-keyword">def</span> <span class="py-defname">__getattr__</span>(self, attribute):
</div>
<div class="docstring functionBody">
<div><p>Getter for all parameters, looks for super if the parameter is prefaced with an underscore. Looks for mandatory parameters first, then secondary parameters. :param attribute: The name of the parameter to get. :type attribute: str :return: The value of the parameter.</p>
</div>
</div>
</div><div class="basemethod">
<a name="bootstraparse.modules.environment.Environment.__init__">
</a>
<a name="__init__">
</a>
<div class="functionHeader">
<span class="py-keyword">def</span> <span class="py-defname">__init__</span>(self):
</div>
<div class="docstring functionBody">
<div><p>Initialises the environment, all parameters are set to None. Set _wasInitialised to False for all parameters.</p>
</div>
</div>
</div><div class="basemethod">
<a name="bootstraparse.modules.environment.Environment.__setattr__">
</a>
<a name="__setattr__">
</a>
<div class="functionHeader">
<span class="py-keyword">def</span> <span class="py-defname">__setattr__</span>(self, attribute, value):
</div>
<div class="docstring functionBody">
<div><p>Setter for all parameters, looks for super if the parameter is prefaced with an underscore. :param attribute: The name of the parameter to set. :type attribute: str</p>
</div>
</div>
</div><div class="basemethod">
<a name="bootstraparse.modules.environment.Environment.integrity_check">
</a>
<a name="integrity_check">
</a>
<div class="functionHeader">
<span class="py-keyword">def</span> <span class="py-defname">integrity_check</span>(self):
</div>
<div class="docstring functionBody">
<div><p>Checks if all mandatory parameters are set. :return: True if all mandatory parameters are set, False otherwise.</p>
</div>
</div>
</div><div class="baseinstancevariable private">
<a name="bootstraparse.modules.environment.Environment._mParams">
</a>
<a name="_mParams">
</a>
<div class="functionHeader">
<span class="py-defname">_mParams</span>: <code>dict</code> =
</div>
<div class="functionBody">
<div><p class="undocumented">Undocumented</p></div>
</div>
</div><div class="baseinstancevariable private">
<a name="bootstraparse.modules.environment.Environment._sParams">
</a>
<a name="_sParams">
</a>
<div class="functionHeader">
<span class="py-defname">_sParams</span>: <code>dict</code> =
</div>
<div class="functionBody">
<div><p class="undocumented">Undocumented</p></div>
</div>
</div><div class="baseinstancevariable private">
<a name="bootstraparse.modules.environment.Environment._wasInitialised">
</a>
<a name="_wasInitialised">
</a>
<div class="functionHeader">
<span class="py-defname">_wasInitialised</span> =
</div>
<div class="functionBody">
<div><p class="undocumented">Undocumented</p></div>
</div>
</div>
</div>
</div>
</div>
<footer class="navbar navbar-default">
<div class="container">
<a href="index.html">API Documentation</a> for bootstraparse,
generated by <a href="https://github.com/twisted/pydoctor/">pydoctor</a>
22.5.1 at 2022-06-15 23:37:16.
</div>
<!-- Search related scripts needs to be loaded at the end of HTML
parsing not to introduce overhead and display HTML data asap -->
<script src="ajax.js" type="text/javascript"></script>
<script src="searchlib.js" type="text/javascript"></script>
<script src="search.js" type="text/javascript"></script>
</footer>
<script src="pydoctor.js" type="text/javascript"></script>
</body>
</html>