bootstraparse/apidoc/bootstraparse.modules.confi...

679 lines
20 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.config.ConfigLoader</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.config.ConfigLoader.html" class="internal-link" title="This class"><wbr></wbr>Config<wbr></wbr>Loader</a></code>
</div>
<div>
<div class="childrenKindTitle">Methods</div>
<ul>
<li class="">
<div class="itemName"><code><a href="#__contains__" class="internal-link" title="bootstraparse.modules.config.ConfigLoader.__contains__">__contains__</a></code>
</div>
</li><li class="">
<div class="itemName"><code><a href="#__getitem__" class="internal-link" title="bootstraparse.modules.config.ConfigLoader.__getitem__">__getitem__</a></code>
</div>
</li><li class="">
<div class="itemName"><code><a href="#__init__" class="internal-link" title="bootstraparse.modules.config.ConfigLoader.__init__">__init__</a></code>
</div>
</li><li class="">
<div class="itemName"><code><a href="#__repr__" class="internal-link" title="bootstraparse.modules.config.ConfigLoader.__repr__">__repr__</a></code>
</div>
</li><li class="">
<div class="itemName"><code><a href="#add_folder" class="internal-link" title="bootstraparse.modules.config.ConfigLoader.add_folder">add<wbr></wbr>_folder</a></code>
</div>
</li><li class="">
<div class="itemName"><code><a href="#load_from_file" class="internal-link" title="bootstraparse.modules.config.ConfigLoader.load_from_file">load<wbr></wbr>_from<wbr></wbr>_file</a></code>
</div>
</li><li class="">
<div class="itemName"><code><a href="#load_from_folder" class="internal-link" title="bootstraparse.modules.config.ConfigLoader.load_from_folder">load<wbr></wbr>_from<wbr></wbr>_folder</a></code>
</div>
</li><li class="">
<div class="itemName"><code><a href="#reload_all" class="internal-link" title="bootstraparse.modules.config.ConfigLoader.reload_all">reload<wbr></wbr>_all</a></code>
</div>
</li>
</ul>
<div class="childrenKindTitle">Attributes</div>
<ul>
<li class="">
<div class="itemName"><code><a href="#config_folders" class="internal-link" title="bootstraparse.modules.config.ConfigLoader.config_folders">config<wbr></wbr>_folders</a></code>
</div>
</li><li class="">
<div class="itemName"><code><a href="#extensions" class="internal-link" title="bootstraparse.modules.config.ConfigLoader.extensions">extensions</a></code>
</div>
</li><li class="">
<div class="itemName"><code><a href="#loaded_conf" class="internal-link" title="bootstraparse.modules.config.ConfigLoader.loaded_conf">loaded<wbr></wbr>_conf</a></code>
</div>
</li>
</ul>
</div>
</div><div>
<div class="thingTitle">
<span>Module</span>
<code><a href="bootstraparse.modules.config.html" class="internal-link" title="The parent of this class">config</a></code>
</div>
<div>
<div class="childrenKindTitle">Classes</div>
<ul>
<li class=" thisobject">
<div class="itemName"><code><a href="bootstraparse.modules.config.ConfigLoader.html" class="internal-link" title="bootstraparse.modules.config.ConfigLoader"><wbr></wbr>Config<wbr></wbr>Loader</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.config.html" class="internal-link" title="bootstraparse.modules.config">config</a></code><wbr></wbr>.<code><a href="bootstraparse.modules.config.ConfigLoader.html" class="internal-link" title="bootstraparse.modules.config.ConfigLoader">ConfigLoader</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">ConfigLoader</span>:</code></p>
<p><a href="classIndex.html#bootstraparse.modules.config.ConfigLoader">View In Hierarchy</a></p>
</div>
<div class="moduleDocstring">
<div><p>Reads all config files in a folder Behaves like a dictionary of all config files</p>
</div>
</div>
<div id="splitTables">
<table class="children sortable" id="id5">
<tr class="method">
<td>Method</td>
<td><code><a href="#__contains__" class="internal-link" title="bootstraparse.modules.config.ConfigLoader.__contains__">__contains__</a></code></td>
<td>Same as a dictionary. :param item: config key :type item: str :return: True if item is in self.loaded_conf</td>
</tr><tr class="method">
<td>Method</td>
<td><code><a href="#__getitem__" class="internal-link" title="bootstraparse.modules.config.ConfigLoader.__getitem__">__getitem__</a></code></td>
<td>Returns a yaml config object if in self.loaded_conf :param item: config key :type item: str :raise KeyError: if item is not in self.loaded_conf :return: config value</td>
</tr><tr class="method">
<td>Method</td>
<td><code><a href="#__init__" class="internal-link" title="bootstraparse.modules.config.ConfigLoader.__init__">__init__</a></code></td>
<td>Defines the config folder and loads all configs :param config_folder: path to config file :type config_folder: (str | list[str]) :param extensions: file extensions to load :type extensions: list[str] :raise TypeError: if config_folder is not a string or a list of strings...</td>
</tr><tr class="method">
<td>Method</td>
<td><code><a href="#__repr__" class="internal-link" title="bootstraparse.modules.config.ConfigLoader.__repr__">__repr__</a></code></td>
<td>Returns config as string :return: the dict of configs and their values :rtype: str</td>
</tr><tr class="method">
<td>Method</td>
<td><code><a href="#add_folder" class="internal-link" title="bootstraparse.modules.config.ConfigLoader.add_folder">add<wbr></wbr>_folder</a></code></td>
<td>Add a Folder to the list of configs :param folder: path to folder :type folder: str :return: None</td>
</tr><tr class="method">
<td>Method</td>
<td><code><a href="#load_from_file" class="internal-link" title="bootstraparse.modules.config.ConfigLoader.load_from_file">load<wbr></wbr>_from<wbr></wbr>_file</a></code></td>
<td>Loads a config file :param filepath: path to config file :type filepath: str :return: None</td>
</tr><tr class="method">
<td>Method</td>
<td><code><a href="#load_from_folder" class="internal-link" title="bootstraparse.modules.config.ConfigLoader.load_from_folder">load<wbr></wbr>_from<wbr></wbr>_folder</a></code></td>
<td>Loads all configs in the config folder :param folder: path to folder :type folder: str :return: None</td>
</tr><tr class="method">
<td>Method</td>
<td><code><a href="#reload_all" class="internal-link" title="bootstraparse.modules.config.ConfigLoader.reload_all">reload<wbr></wbr>_all</a></code></td>
<td>Reloads all configs :return: None</td>
</tr><tr class="instancevariable">
<td>Instance Variable</td>
<td><code><a href="#config_folders" class="internal-link" title="bootstraparse.modules.config.ConfigLoader.config_folders">config<wbr></wbr>_folders</a></code></td>
<td><span class="undocumented">Undocumented</span></td>
</tr><tr class="instancevariable">
<td>Instance Variable</td>
<td><code><a href="#extensions" class="internal-link" title="bootstraparse.modules.config.ConfigLoader.extensions">extensions</a></code></td>
<td><span class="undocumented">Undocumented</span></td>
</tr><tr class="instancevariable">
<td>Instance Variable</td>
<td><code><a href="#loaded_conf" class="internal-link" title="bootstraparse.modules.config.ConfigLoader.loaded_conf">loaded<wbr></wbr>_conf</a></code></td>
<td><span class="undocumented">Undocumented</span></td>
</tr>
</table>
</div>
<div id="childList">
<div class="basemethod">
<a name="bootstraparse.modules.config.ConfigLoader.__contains__">
</a>
<a name="__contains__">
</a>
<div class="functionHeader">
<span class="py-keyword">def</span> <span class="py-defname">__contains__</span>(self, item):
</div>
<div class="docstring functionBody">
<div><p>Same as a dictionary. :param item: config key :type item: str :return: True if item is in self.loaded_conf</p>
</div>
</div>
</div><div class="basemethod">
<a name="bootstraparse.modules.config.ConfigLoader.__getitem__">
</a>
<a name="__getitem__">
</a>
<div class="functionHeader">
<span class="py-keyword">def</span> <span class="py-defname">__getitem__</span>(self, item):
</div>
<div class="docstring functionBody">
<div><p>Returns a yaml config object if in self.loaded_conf :param item: config key :type item: str :raise KeyError: if item is not in self.loaded_conf :return: config value</p>
</div>
</div>
</div><div class="basemethod">
<a name="bootstraparse.modules.config.ConfigLoader.__init__">
</a>
<a name="__init__">
</a>
<div class="functionHeader">
<span class="py-keyword">def</span> <span class="py-defname">__init__</span>(self, config_folder=None, extensions=(<wbr></wbr><span class="rst-variable-quote">'</span><span class="rst-variable-string">yaml</span><span class="rst-variable-quote">'</span>, <wbr></wbr><span class="rst-variable-quote">'</span><span class="rst-variable-string">yml</span><span class="rst-variable-quote">'</span>)):
</div>
<div class="docstring functionBody">
<div><p>Defines the config folder and loads all configs :param config_folder: path to config file :type config_folder: (str | list[str]) :param extensions: file extensions to load :type extensions: list[str] :raise TypeError: if config_folder is not a string or a list of strings</p>
</div>
</div>
</div><div class="basemethod">
<a name="bootstraparse.modules.config.ConfigLoader.__repr__">
</a>
<a name="__repr__">
</a>
<div class="functionHeader">
<span class="py-keyword">def</span> <span class="py-defname">__repr__</span>(self):
</div>
<div class="docstring functionBody">
<div><p>Returns config as string :return: the dict of configs and their values :rtype: str</p>
</div>
</div>
</div><div class="basemethod">
<a name="bootstraparse.modules.config.ConfigLoader.add_folder">
</a>
<a name="add_folder">
</a>
<div class="functionHeader">
<span class="py-keyword">def</span> <span class="py-defname">add_folder</span>(self, folder):
</div>
<div class="docstring functionBody">
<div><p>Add a Folder to the list of configs :param folder: path to folder :type folder: str :return: None</p>
</div>
</div>
</div><div class="basemethod">
<a name="bootstraparse.modules.config.ConfigLoader.load_from_file">
</a>
<a name="load_from_file">
</a>
<div class="functionHeader">
<span class="py-keyword">def</span> <span class="py-defname">load_from_file</span>(self, filepath):
</div>
<div class="docstring functionBody">
<div><p>Loads a config file :param filepath: path to config file :type filepath: str :return: None</p>
</div>
</div>
</div><div class="basemethod">
<a name="bootstraparse.modules.config.ConfigLoader.load_from_folder">
</a>
<a name="load_from_folder">
</a>
<div class="functionHeader">
<span class="py-keyword">def</span> <span class="py-defname">load_from_folder</span>(self, folder):
</div>
<div class="docstring functionBody">
<div><p>Loads all configs in the config folder :param folder: path to folder :type folder: str :return: None</p>
</div>
</div>
</div><div class="basemethod">
<a name="bootstraparse.modules.config.ConfigLoader.reload_all">
</a>
<a name="reload_all">
</a>
<div class="functionHeader">
<span class="py-keyword">def</span> <span class="py-defname">reload_all</span>(self):
</div>
<div class="docstring functionBody">
<div><p>Reloads all configs :return: None</p>
</div>
</div>
</div><div class="baseinstancevariable">
<a name="bootstraparse.modules.config.ConfigLoader.config_folders">
</a>
<a name="config_folders">
</a>
<div class="functionHeader">
<span class="py-defname">config_folders</span>: <code>list</code> =
</div>
<div class="functionBody">
<div><p class="undocumented">Undocumented</p></div>
</div>
</div><div class="baseinstancevariable">
<a name="bootstraparse.modules.config.ConfigLoader.extensions">
</a>
<a name="extensions">
</a>
<div class="functionHeader">
<span class="py-defname">extensions</span> =
</div>
<div class="functionBody">
<div><p class="undocumented">Undocumented</p></div>
</div>
</div><div class="baseinstancevariable">
<a name="bootstraparse.modules.config.ConfigLoader.loaded_conf">
</a>
<a name="loaded_conf">
</a>
<div class="functionHeader">
<span class="py-defname">loaded_conf</span>: <code>dict</code> =
</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-16 02:05:35.
</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>