kev
/
Onionr
1
0
Fork 0
Code Issues 24 Pull Requests Projects Releases 2 Wiki Activity
Onionr/docs/html/onionr/config.html

421 lines
17 KiB
HTML
Raw Normal View History

added auto generated api documentation
2019-09-23 23:20:14 +00:00
<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
<meta name="generator" content="pdoc 0.6.3" />
<title>onionr.config API documentation</title>
<meta name="description" content="Onionr - Private P2P Communication …" />
<link href='https://cdnjs.cloudflare.com/ajax/libs/normalize/8.0.0/normalize.min.css' rel='stylesheet'>
<link href='https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/8.0.0/sanitize.min.css' rel='stylesheet'>
<link href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/github.min.css" rel="stylesheet">
<style>.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:30px;overflow:hidden}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:1em 0 .50em 0}h3{font-size:1.4em;margin:25px 0 10px 0}h4{margin:0;font-size:105%}a{color:#058;text-decoration:none;transition:color .3s ease-in-out}a:hover{color:#e82}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900}pre code{background:#f8f8f8;font-size:.8em;line-height:1.4em}code{background:#f2f2f1;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{background:#f8f8f8;border:0;border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0;padding:1ex}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{font-weight:bold}#index h4 + ul{margin-bottom:.6em}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-weight:bold;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source summary{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase;cursor:pointer}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}.admonition{padding:.1em .5em;margin-bottom:1em}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style>
<style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:1em}.item .name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul{padding-left:1.5em}.toc > ul > li{margin-top:.5em}}</style>
<style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style>
</head>
<body>
<main>
<article id="content">
<header>
<h1 class="title">Module <code>onionr.config</code></h1>
</header>
<section id="section-intro">
<p>Onionr - Private P2P Communication</p>
<p>This file deals with configuration management.</p>
<details class="source">
<summary>Source code</summary>
<pre><code class="python">&#39;&#39;&#39;
Onionr - Private P2P Communication
This file deals with configuration management.
&#39;&#39;&#39;
&#39;&#39;&#39;
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see &lt;https://www.gnu.org/licenses/&gt;.
&#39;&#39;&#39;
import os, json, logger
import filepaths
_configfile = filepaths.config_file
_config = {}
def get(key, default = None, save = False):
&#39;&#39;&#39;
Gets the key from configuration, or returns `default`
&#39;&#39;&#39;
key = str(key).split(&#39;.&#39;)
data = _config
last = key.pop()
for item in key:
if (not item in data) or (not type(data[item]) == dict):
return default
data = data[item]
if not last in data:
if save:
set(key, default, savefile = True)
return default
return data[last]
def set(key, value = None, savefile = False):
&#39;&#39;&#39;
Sets the key in configuration to `value`
&#39;&#39;&#39;
global _config
key = str(key).split(&#39;.&#39;)
data = _config
last = key.pop()
for item in key:
if (not item in data) or (not type(data[item]) == dict):
data[item] = dict()
data = data[item]
if value is None:
del data[last]
else:
data[last] = value
if savefile:
save()
def is_set(key):
key = str(key).split(&#39;.&#39;)
data = _config
last = key.pop()
for item in key:
if (not item in data) or (not type(data[item]) == dict):
return False
data = data[item]
if not last in data:
return False
return True
def check():
&#39;&#39;&#39;
Checks if the configuration file exists, creates it if not
&#39;&#39;&#39;
if not os.path.exists(os.path.dirname(get_config_file())):
os.makedirs(os.path.dirname(get_config_file()))
def save():
&#39;&#39;&#39;
Saves the configuration data to the configuration file
&#39;&#39;&#39;
check()
try:
with open(get_config_file(), &#39;w&#39;, encoding=&#34;utf8&#34;) as configfile:
json.dump(get_config(), configfile, indent=2)
except json.JSONDecodeError:
logger.warn(&#39;Failed to write to configuration file.&#39;)
def reload():
&#39;&#39;&#39;
Reloads the configuration data in memory from the file
&#39;&#39;&#39;
check()
try:
with open(get_config_file(), &#39;r&#39;, encoding=&#34;utf8&#34;) as configfile:
set_config(json.loads(configfile.read()))
except (FileNotFoundError, json.JSONDecodeError) as e:
pass
#logger.debug(&#39;Failed to parse configuration file.&#39;)
def get_config():
&#39;&#39;&#39;
Gets the entire configuration as an array
&#39;&#39;&#39;
return _config
def set_config(config):
&#39;&#39;&#39;
Sets the configuration to the array in arguments
&#39;&#39;&#39;
global _config
_config = config
def get_config_file():
&#39;&#39;&#39;
Returns the absolute path to the configuration file
&#39;&#39;&#39;
return _configfile
def set_config_file(configfile):
&#39;&#39;&#39;
Sets the path to the configuration file
&#39;&#39;&#39;
global _configfile
_configfile = os.abs.abspath(configfile)</code></pre>
</details>
</section>
<section>
</section>
<section>
</section>
<section>
<h2 class="section-title" id="header-functions">Functions</h2>
<dl>
<dt id="onionr.config.check"><code class="name flex">
<span>def <span class="ident">check</span></span>(<span>)</span>
</code></dt>
<dd>
<section class="desc"><p>Checks if the configuration file exists, creates it if not</p></section>
<details class="source">
<summary>Source code</summary>
<pre><code class="python">def check():
&#39;&#39;&#39;
Checks if the configuration file exists, creates it if not
&#39;&#39;&#39;
if not os.path.exists(os.path.dirname(get_config_file())):
os.makedirs(os.path.dirname(get_config_file()))</code></pre>
</details>
</dd>
<dt id="onionr.config.get"><code class="name flex">
<span>def <span class="ident">get</span></span>(<span>key, default=None, save=False)</span>
</code></dt>
<dd>
<section class="desc"><p>Gets the key from configuration, or returns <code>default</code></p></section>
<details class="source">
<summary>Source code</summary>
<pre><code class="python">def get(key, default = None, save = False):
&#39;&#39;&#39;
Gets the key from configuration, or returns `default`
&#39;&#39;&#39;
key = str(key).split(&#39;.&#39;)
data = _config
last = key.pop()
for item in key:
if (not item in data) or (not type(data[item]) == dict):
return default
data = data[item]
if not last in data:
if save:
set(key, default, savefile = True)
return default
return data[last]</code></pre>
</details>
</dd>
<dt id="onionr.config.get_config"><code class="name flex">
<span>def <span class="ident">get_config</span></span>(<span>)</span>
</code></dt>
<dd>
<section class="desc"><p>Gets the entire configuration as an array</p></section>
<details class="source">
<summary>Source code</summary>
<pre><code class="python">def get_config():
&#39;&#39;&#39;
Gets the entire configuration as an array
&#39;&#39;&#39;
return _config</code></pre>
</details>
</dd>
<dt id="onionr.config.get_config_file"><code class="name flex">
<span>def <span class="ident">get_config_file</span></span>(<span>)</span>
</code></dt>
<dd>
<section class="desc"><p>Returns the absolute path to the configuration file</p></section>
<details class="source">
<summary>Source code</summary>
<pre><code class="python">def get_config_file():
&#39;&#39;&#39;
Returns the absolute path to the configuration file
&#39;&#39;&#39;
return _configfile</code></pre>
</details>
</dd>
<dt id="onionr.config.is_set"><code class="name flex">
<span>def <span class="ident">is_set</span></span>(<span>key)</span>
</code></dt>
<dd>
<section class="desc"></section>
<details class="source">
<summary>Source code</summary>
<pre><code class="python">def is_set(key):
key = str(key).split(&#39;.&#39;)
data = _config
last = key.pop()
for item in key:
if (not item in data) or (not type(data[item]) == dict):
return False
data = data[item]
if not last in data:
return False
return True</code></pre>
</details>
</dd>
<dt id="onionr.config.reload"><code class="name flex">
<span>def <span class="ident">reload</span></span>(<span>)</span>
</code></dt>
<dd>
<section class="desc"><p>Reloads the configuration data in memory from the file</p></section>
<details class="source">
<summary>Source code</summary>
<pre><code class="python">def reload():
&#39;&#39;&#39;
Reloads the configuration data in memory from the file
&#39;&#39;&#39;
check()
try:
with open(get_config_file(), &#39;r&#39;, encoding=&#34;utf8&#34;) as configfile:
set_config(json.loads(configfile.read()))
except (FileNotFoundError, json.JSONDecodeError) as e:
pass</code></pre>
</details>
</dd>
<dt id="onionr.config.save"><code class="name flex">
<span>def <span class="ident">save</span></span>(<span>)</span>
</code></dt>
<dd>
<section class="desc"><p>Saves the configuration data to the configuration file</p></section>
<details class="source">
<summary>Source code</summary>
<pre><code class="python">def save():
&#39;&#39;&#39;
Saves the configuration data to the configuration file
&#39;&#39;&#39;
check()
try:
with open(get_config_file(), &#39;w&#39;, encoding=&#34;utf8&#34;) as configfile:
json.dump(get_config(), configfile, indent=2)
except json.JSONDecodeError:
logger.warn(&#39;Failed to write to configuration file.&#39;)</code></pre>
</details>
</dd>
<dt id="onionr.config.set"><code class="name flex">
<span>def <span class="ident">set</span></span>(<span>key, value=None, savefile=False)</span>
</code></dt>
<dd>
<section class="desc"><p>Sets the key in configuration to <code>value</code></p></section>
<details class="source">
<summary>Source code</summary>
<pre><code class="python">def set(key, value = None, savefile = False):
&#39;&#39;&#39;
Sets the key in configuration to `value`
&#39;&#39;&#39;
global _config
key = str(key).split(&#39;.&#39;)
data = _config
last = key.pop()
for item in key:
if (not item in data) or (not type(data[item]) == dict):
data[item] = dict()
data = data[item]
if value is None:
del data[last]
else:
data[last] = value
if savefile:
save()</code></pre>
</details>
</dd>
<dt id="onionr.config.set_config"><code class="name flex">
<span>def <span class="ident">set_config</span></span>(<span>config)</span>
</code></dt>
<dd>
<section class="desc"><p>Sets the configuration to the array in arguments</p></section>
<details class="source">
<summary>Source code</summary>
<pre><code class="python">def set_config(config):
&#39;&#39;&#39;
Sets the configuration to the array in arguments
&#39;&#39;&#39;
global _config
_config = config</code></pre>
</details>
</dd>
<dt id="onionr.config.set_config_file"><code class="name flex">
<span>def <span class="ident">set_config_file</span></span>(<span>configfile)</span>
</code></dt>
<dd>
<section class="desc"><p>Sets the path to the configuration file</p></section>
<details class="source">
<summary>Source code</summary>
<pre><code class="python">def set_config_file(configfile):
&#39;&#39;&#39;
Sets the path to the configuration file
&#39;&#39;&#39;
global _configfile
_configfile = os.abs.abspath(configfile)</code></pre>
</details>
</dd>
</dl>
</section>
<section>
</section>
</article>
<nav id="sidebar">
<h1>Index</h1>
<div class="toc">
<ul></ul>
</div>
<ul id="index">
<li><h3>Super-module</h3>
<ul>
<li><code><a title="onionr" href="index.html">onionr</a></code></li>
</ul>
</li>
<li><h3><a href="#header-functions">Functions</a></h3>
<ul class="two-column">
<li><code><a title="onionr.config.check" href="#onionr.config.check">check</a></code></li>
<li><code><a title="onionr.config.get" href="#onionr.config.get">get</a></code></li>
<li><code><a title="onionr.config.get_config" href="#onionr.config.get_config">get_config</a></code></li>
<li><code><a title="onionr.config.get_config_file" href="#onionr.config.get_config_file">get_config_file</a></code></li>
<li><code><a title="onionr.config.is_set" href="#onionr.config.is_set">is_set</a></code></li>
<li><code><a title="onionr.config.reload" href="#onionr.config.reload">reload</a></code></li>
<li><code><a title="onionr.config.save" href="#onionr.config.save">save</a></code></li>
<li><code><a title="onionr.config.set" href="#onionr.config.set">set</a></code></li>
<li><code><a title="onionr.config.set_config" href="#onionr.config.set_config">set_config</a></code></li>
<li><code><a title="onionr.config.set_config_file" href="#onionr.config.set_config_file">set_config_file</a></code></li>
</ul>
</li>
</ul>
</nav>
</main>
<footer id="footer">
<p>Generated by <a href="https://pdoc3.github.io/pdoc"><cite>pdoc</cite> 0.6.3</a>.</p>
</footer>
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/highlight.min.js"></script>
<script>hljs.initHighlightingOnLoad()</script>
</body>
</html>