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" / >
2020-02-04 20:46:17 +00:00
< meta name = "generator" content = "pdoc 0.7.4" / >
< title > src.config API documentation< / title >
2019-09-23 23:20:14 +00:00
< 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" >
2020-02-04 20:46:17 +00:00
< style > . flex { display : flex !important } body { line-height : 1.5 em } # content { padding : 20 px } # sidebar { padding : 30 px ; overflow : hidden } . http-server-breadcrumbs { font-size : 130 % ; margin : 0 0 15 px 0 } # footer { font-size : .75 em ; padding : 5 px 30 px ; border-top : 1 px solid #ddd ; text-align : right } # footer p { margin : 0 0 0 1 em ; display : inline-block } # footer p : last-child { margin-right : 30 px } h1 , h2 , h3 , h4 , h5 { font-weight : 300 } h1 { font-size : 2.5 em ; line-height : 1.1 em } h2 { font-size : 1.75 em ; margin : 1 em 0 .50 em 0 } h3 { font-size : 1.4 em ; margin : 25 px 0 10 px 0 } h4 { margin : 0 ; font-size : 105 % } a { color : #058 ; text-decoration : none ; transition : color .3 s ease-in-out } a : hover { color : #e82 } . title code { font-weight : bold } h2 [ id ^ = "header-" ] { margin-top : 2 em } . ident { color : #900 } pre code { background : #f8f8f8 ; font-size : .8 em ; line-height : 1.4 em } code { background : #f2f2f1 ; padding : 1 px 4 px ; overflow-wrap : break-word } h1 code { background : transparent } pre { background : #f8f8f8 ; border : 0 ; border-top : 1 px solid #ccc ; border-bottom : 1 px solid #ccc ; margin : 1 em 0 ; padding : 1 ex } # 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 : 1 px solid #ddd } # index ul { padding : 0 } # index h4 { font-weight : bold } # index h4 + ul { margin-bottom : .6 em } @ media ( min-width : 200ex ) { # index . two-column { column-count : 2 } } @ media ( min-width : 300ex ) { # index . two-column { column-count : 3 } } dl { margin-bottom : 2 em } dl dl : last-child { margin-bottom : 4 em } dd { margin : 0 0 1 em 3 em } # header-classes + dl > dd { margin-bottom : 3 em } dd dd { margin-left : 2 em } dd p { margin : 10 px 0 } . name { background : #eee ; font-weight : bold ; font-size : .85 em ; padding : 5 px 10 px ; 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 : .4 em } . inherited { color : #999 ; border-left : 5 px solid #eee ; padding-left : 1 em } . inheritance em { font-style : normal ; font-weight : bold } . desc h2 { font-weight : 400 ; font-size : 1.25 em } . desc h3 { font-size : 1 em } . desc dt code { background : inherit } . source summary , . git-link-div { color : #666 ; text-align : right ; font-weight : 400 ; font-size : .8 em ; text-transform : uppercase } . source summary > * { white-space : nowrap ; cursor : pointer } . git-link { color : inherit ; margin-left : 1 em } . source pre { max-height : 500 px ; overflow : auto ; margin : 0 } . source pre code { font-size : 12 px ; 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 : 1 em } img { max-width : 100 % } . admonition { padding : .1 em .5 em ; margin-bottom : 1 em } . 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 >
2019-09-23 23:20:14 +00:00
< style media = "screen and (min-width: 700px)" > @ media screen and ( min-width : 700px ) { # sidebar { width : 30 % } # content { width : 70 % ; max-width : 100 ch ; padding : 3 em 4 em ; border-left : 1 px solid #ddd } pre code { font-size : 1 em } . item . name { font-size : 1 em } main { display : flex ; flex-direction : row-reverse ; justify-content : flex-end } . toc ul ul , # index ul { padding-left : 1.5 em } . toc > ul > li { margin-top : .5 em } } < / 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 : 1 px 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 >
2020-02-04 20:46:17 +00:00
< h1 class = "title" > Module < code > src.config< / code > < / h1 >
2019-09-23 23:20:14 +00:00
< / header >
< section id = "section-intro" >
2020-02-04 20:46:17 +00:00
< p > Onionr - Private P2P Communication.< / p >
2019-09-23 23:20:14 +00:00
< p > This file deals with configuration management.< / p >
< details class = "source" >
2020-02-04 20:46:17 +00:00
< summary >
< span > Expand source code< / span >
< / summary >
< pre > < code class = "python" > " " " Onionr - Private P2P Communication.
2019-09-23 23:20:14 +00:00
2020-02-04 20:46:17 +00:00
This file deals with configuration management.
" " "
import os, json, logger
import filepaths
from . import onboarding
" " "
2019-09-23 23:20:14 +00:00
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 < https://www.gnu.org/licenses/> .
2020-02-04 20:46:17 +00:00
" " "
2019-09-23 23:20:14 +00:00
_configfile = filepaths.config_file
_config = {}
2020-02-04 20:46:17 +00:00
2019-09-23 23:20:14 +00:00
def get(key, default = None, save = False):
2020-02-04 20:46:17 +00:00
" " " Gets the key from configuration, or returns `default`" " "
2019-09-23 23:20:14 +00:00
key = str(key).split(' .' )
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]
2020-02-04 20:46:17 +00:00
if last not in data:
2019-09-23 23:20:14 +00:00
if save:
set(key, default, savefile = True)
return default
return data[last]
2020-02-04 20:46:17 +00:00
2019-09-23 23:20:14 +00:00
def set(key, value = None, savefile = False):
2020-02-04 20:46:17 +00:00
" " " Sets the key in configuration to `value`" " "
2019-09-23 23:20:14 +00:00
global _config
2020-02-04 20:46:17 +00:00
whole_key = key
2019-09-23 23:20:14 +00:00
key = str(key).split(' .' )
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()
2020-02-04 20:46:17 +00:00
2019-09-23 23:20:14 +00:00
def is_set(key):
key = str(key).split(' .' )
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
2020-02-04 20:46:17 +00:00
2019-09-23 23:20:14 +00:00
def check():
2020-02-04 20:46:17 +00:00
" " " Checks if the configuration file exists, creates it if not" " "
2019-09-23 23:20:14 +00:00
if not os.path.exists(os.path.dirname(get_config_file())):
os.makedirs(os.path.dirname(get_config_file()))
2020-02-04 20:46:17 +00:00
2019-09-23 23:20:14 +00:00
def save():
2020-02-04 20:46:17 +00:00
" " " Saves the configuration data to the configuration file" " "
2019-09-23 23:20:14 +00:00
check()
try:
with open(get_config_file(), ' w' , encoding=" utf8" ) as configfile:
json.dump(get_config(), configfile, indent=2)
except json.JSONDecodeError:
logger.warn(' Failed to write to configuration file.' )
2020-02-04 20:46:17 +00:00
2019-09-23 23:20:14 +00:00
def reload():
2020-02-04 20:46:17 +00:00
" " " Reloads the configuration data in memory from the file" " "
2019-09-23 23:20:14 +00:00
check()
try:
with open(get_config_file(), ' r' , encoding=" utf8" ) as configfile:
set_config(json.loads(configfile.read()))
except (FileNotFoundError, json.JSONDecodeError) as e:
pass
#logger.debug(' Failed to parse configuration file.' )
2020-02-04 20:46:17 +00:00
2019-09-23 23:20:14 +00:00
def get_config():
2020-02-04 20:46:17 +00:00
" " " Gets the entire configuration as an array" " "
2019-09-23 23:20:14 +00:00
return _config
2020-02-04 20:46:17 +00:00
2019-09-23 23:20:14 +00:00
def set_config(config):
2020-02-04 20:46:17 +00:00
" " " Sets the configuration to the array in arguments" " "
2019-09-23 23:20:14 +00:00
global _config
_config = config
2020-02-04 20:46:17 +00:00
2019-09-23 23:20:14 +00:00
def get_config_file():
2020-02-04 20:46:17 +00:00
" " " Returns the absolute path to the configuration file" " "
2019-09-23 23:20:14 +00:00
return _configfile
2020-02-04 20:46:17 +00:00
2019-09-23 23:20:14 +00:00
def set_config_file(configfile):
2020-02-04 20:46:17 +00:00
" " " Sets the path to the configuration file." " "
2019-09-23 23:20:14 +00:00
global _configfile
_configfile = os.abs.abspath(configfile)< / code > < / pre >
< / details >
< / section >
< section >
2020-02-04 20:46:17 +00:00
< h2 class = "section-title" id = "header-submodules" > Sub-modules< / h2 >
< dl >
< dt > < code class = "name" > < a title = "src.config.onboarding" href = "onboarding.html" > src.config.onboarding< / a > < / code > < / dt >
< dd >
< section class = "desc" > < p > Onionr - Private P2P Communication …< / p > < / section >
< / dd >
< / dl >
2019-09-23 23:20:14 +00:00
< / section >
< section >
< / section >
< section >
< h2 class = "section-title" id = "header-functions" > Functions< / h2 >
< dl >
2020-02-04 20:46:17 +00:00
< dt id = "src.config.check" > < code class = "name flex" >
2019-09-23 23:20:14 +00:00
< 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" >
2020-02-04 20:46:17 +00:00
< summary >
< span > Expand source code< / span >
< / summary >
2019-09-23 23:20:14 +00:00
< pre > < code class = "python" > def check():
2020-02-04 20:46:17 +00:00
" " " Checks if the configuration file exists, creates it if not" " "
2019-09-23 23:20:14 +00:00
if not os.path.exists(os.path.dirname(get_config_file())):
os.makedirs(os.path.dirname(get_config_file()))< / code > < / pre >
< / details >
< / dd >
2020-02-04 20:46:17 +00:00
< dt id = "src.config.get" > < code class = "name flex" >
2019-09-23 23:20:14 +00:00
< 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" >
2020-02-04 20:46:17 +00:00
< summary >
< span > Expand source code< / span >
< / summary >
2019-09-23 23:20:14 +00:00
< pre > < code class = "python" > def get(key, default = None, save = False):
2020-02-04 20:46:17 +00:00
" " " Gets the key from configuration, or returns `default`" " "
2019-09-23 23:20:14 +00:00
key = str(key).split(' .' )
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]
2020-02-04 20:46:17 +00:00
if last not in data:
2019-09-23 23:20:14 +00:00
if save:
set(key, default, savefile = True)
return default
return data[last]< / code > < / pre >
< / details >
< / dd >
2020-02-04 20:46:17 +00:00
< dt id = "src.config.get_config" > < code class = "name flex" >
2019-09-23 23:20:14 +00:00
< 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" >
2020-02-04 20:46:17 +00:00
< summary >
< span > Expand source code< / span >
< / summary >
2019-09-23 23:20:14 +00:00
< pre > < code class = "python" > def get_config():
2020-02-04 20:46:17 +00:00
" " " Gets the entire configuration as an array" " "
2019-09-23 23:20:14 +00:00
return _config< / code > < / pre >
< / details >
< / dd >
2020-02-04 20:46:17 +00:00
< dt id = "src.config.get_config_file" > < code class = "name flex" >
2019-09-23 23:20:14 +00:00
< 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" >
2020-02-04 20:46:17 +00:00
< summary >
< span > Expand source code< / span >
< / summary >
2019-09-23 23:20:14 +00:00
< pre > < code class = "python" > def get_config_file():
2020-02-04 20:46:17 +00:00
" " " Returns the absolute path to the configuration file" " "
2019-09-23 23:20:14 +00:00
return _configfile< / code > < / pre >
< / details >
< / dd >
2020-02-04 20:46:17 +00:00
< dt id = "src.config.is_set" > < code class = "name flex" >
2019-09-23 23:20:14 +00:00
< span > def < span class = "ident" > is_set< / span > < / span > (< span > key)< / span >
< / code > < / dt >
< dd >
< section class = "desc" > < / section >
< details class = "source" >
2020-02-04 20:46:17 +00:00
< summary >
< span > Expand source code< / span >
< / summary >
2019-09-23 23:20:14 +00:00
< pre > < code class = "python" > def is_set(key):
key = str(key).split(' .' )
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 >
2020-02-04 20:46:17 +00:00
< dt id = "src.config.reload" > < code class = "name flex" >
2019-09-23 23:20:14 +00:00
< 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" >
2020-02-04 20:46:17 +00:00
< summary >
< span > Expand source code< / span >
< / summary >
2019-09-23 23:20:14 +00:00
< pre > < code class = "python" > def reload():
2020-02-04 20:46:17 +00:00
" " " Reloads the configuration data in memory from the file" " "
2019-09-23 23:20:14 +00:00
check()
try:
with open(get_config_file(), ' r' , encoding=" utf8" ) as configfile:
set_config(json.loads(configfile.read()))
except (FileNotFoundError, json.JSONDecodeError) as e:
pass< / code > < / pre >
< / details >
< / dd >
2020-02-04 20:46:17 +00:00
< dt id = "src.config.save" > < code class = "name flex" >
2019-09-23 23:20:14 +00:00
< 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" >
2020-02-04 20:46:17 +00:00
< summary >
< span > Expand source code< / span >
< / summary >
2019-09-23 23:20:14 +00:00
< pre > < code class = "python" > def save():
2020-02-04 20:46:17 +00:00
" " " Saves the configuration data to the configuration file" " "
2019-09-23 23:20:14 +00:00
check()
try:
with open(get_config_file(), ' w' , encoding=" utf8" ) as configfile:
json.dump(get_config(), configfile, indent=2)
except json.JSONDecodeError:
logger.warn(' Failed to write to configuration file.' )< / code > < / pre >
< / details >
< / dd >
2020-02-04 20:46:17 +00:00
< dt id = "src.config.set" > < code class = "name flex" >
2019-09-23 23:20:14 +00:00
< 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" >
2020-02-04 20:46:17 +00:00
< summary >
< span > Expand source code< / span >
< / summary >
2019-09-23 23:20:14 +00:00
< pre > < code class = "python" > def set(key, value = None, savefile = False):
2020-02-04 20:46:17 +00:00
" " " Sets the key in configuration to `value`" " "
2019-09-23 23:20:14 +00:00
global _config
2020-02-04 20:46:17 +00:00
whole_key = key
2019-09-23 23:20:14 +00:00
key = str(key).split(' .' )
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 >
2020-02-04 20:46:17 +00:00
< dt id = "src.config.set_config" > < code class = "name flex" >
2019-09-23 23:20:14 +00:00
< 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" >
2020-02-04 20:46:17 +00:00
< summary >
< span > Expand source code< / span >
< / summary >
2019-09-23 23:20:14 +00:00
< pre > < code class = "python" > def set_config(config):
2020-02-04 20:46:17 +00:00
" " " Sets the configuration to the array in arguments" " "
2019-09-23 23:20:14 +00:00
global _config
_config = config< / code > < / pre >
< / details >
< / dd >
2020-02-04 20:46:17 +00:00
< dt id = "src.config.set_config_file" > < code class = "name flex" >
2019-09-23 23:20:14 +00:00
< span > def < span class = "ident" > set_config_file< / span > < / span > (< span > configfile)< / span >
< / code > < / dt >
< dd >
2020-02-04 20:46:17 +00:00
< section class = "desc" > < p > Sets the path to the configuration file.< / p > < / section >
2019-09-23 23:20:14 +00:00
< details class = "source" >
2020-02-04 20:46:17 +00:00
< summary >
< span > Expand source code< / span >
< / summary >
2019-09-23 23:20:14 +00:00
< pre > < code class = "python" > def set_config_file(configfile):
2020-02-04 20:46:17 +00:00
" " " Sets the path to the configuration file." " "
2019-09-23 23:20:14 +00:00
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 >
2020-02-04 20:46:17 +00:00
< li > < code > < a title = "src" href = "../index.html" > src< / a > < / code > < / li >
< / ul >
< / li >
< li > < h3 > < a href = "#header-submodules" > Sub-modules< / a > < / h3 >
< ul >
< li > < code > < a title = "src.config.onboarding" href = "onboarding.html" > src.config.onboarding< / a > < / code > < / li >
2019-09-23 23:20:14 +00:00
< / ul >
< / li >
< li > < h3 > < a href = "#header-functions" > Functions< / a > < / h3 >
< ul class = "two-column" >
2020-02-04 20:46:17 +00:00
< li > < code > < a title = "src.config.check" href = "#src.config.check" > check< / a > < / code > < / li >
< li > < code > < a title = "src.config.get" href = "#src.config.get" > get< / a > < / code > < / li >
< li > < code > < a title = "src.config.get_config" href = "#src.config.get_config" > get_config< / a > < / code > < / li >
< li > < code > < a title = "src.config.get_config_file" href = "#src.config.get_config_file" > get_config_file< / a > < / code > < / li >
< li > < code > < a title = "src.config.is_set" href = "#src.config.is_set" > is_set< / a > < / code > < / li >
< li > < code > < a title = "src.config.reload" href = "#src.config.reload" > reload< / a > < / code > < / li >
< li > < code > < a title = "src.config.save" href = "#src.config.save" > save< / a > < / code > < / li >
< li > < code > < a title = "src.config.set" href = "#src.config.set" > set< / a > < / code > < / li >
< li > < code > < a title = "src.config.set_config" href = "#src.config.set_config" > set_config< / a > < / code > < / li >
< li > < code > < a title = "src.config.set_config_file" href = "#src.config.set_config_file" > set_config_file< / a > < / code > < / li >
2019-09-23 23:20:14 +00:00
< / ul >
< / li >
< / ul >
< / nav >
< / main >
< footer id = "footer" >
2020-02-04 20:46:17 +00:00
< p > Generated by < a href = "https://pdoc3.github.io/pdoc" > < cite > pdoc< / cite > 0.7.4< / a > .< / p >
2019-09-23 23:20:14 +00:00
< / footer >
< script src = "https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/highlight.min.js" > < / script >
< script > hljs . initHighlightingOnLoad ( ) < / script >
< / body >
< / html >
