Module geode.conf
Expand source code
# ------------------------------------------------------------------------------
# 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.
#
# 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, write to the Free Software
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
# MA 02110-1301, USA.
# ------------------------------------------------------------------------------
# Filesysystem
from pathlib import Path
# Configuration
from configparser import ConfigParser
# ------------------------------------------------------------------------------
# Class
# ------------------------------------------------------------------------------
class Configuration(ConfigParser):
def __init__(self, filepath, **kwargs):
""" Constructor
Parameters
----------
filepath : str or pathlib.Path
Configuration file path
"""
ConfigParser.__init__(self, kwargs)
if type(filepath) is not str:
raise ValueError("Wrong type for filepath, expected str")
# Keep case sensitive for option label
self.optionxform = str
self.path = Path(filepath).expanduser()
if self.path.exists():
self.read(self.path)
def __str__(self):
""" Formated informations
Returns
-------
str
Formated string
"""
text = list()
for section in sorted(self.sections()):
text.append("[%s]" % section)
for key in sorted(self.options(section)):
text.append("%s = %s" % (
key, self.get(section, key, fallback=str())))
return '\n'.join(text)
def item(self, section, option, default=None):
""" Return an item from configuration
Parameters
----------
section : str
Section name
option : str
Option name
default : str, optional
Fallback value to return if nothing has been founded (default: None)
Returns
-------
str or None
Value from section option
"""
if self.has_section(section) and self.has_option(section, option):
return self.get(section, option)
return default
def append(self, section, option, value):
""" Append a new section to configuration
Parameters
----------
section : str
Section name
option : str
Option name
value : str
Value to set
Raises
------
IndexError
If the configuration file not has section
"""
if self.has_section(section):
raise IndexError("Cannot find %s section" % section)
self.add_section(section)
self.set(section, option, str(value))
def modify(self, section, option, value):
""" Modify a section from configuration
This function append or update a section into configuration
Parameters
----------
section : str
Section name
option : str
Option name
value : object
Value to set
"""
# ----------------------------------------
# Specific variables
# ----------------------------------------
if type(value) is bool:
if value:
value = "yes"
else:
value = "no"
elif type(value) is list:
value = ' '.join(value)
elif value is None:
value = str()
# ----------------------------------------
# Section
# ----------------------------------------
if self.has_section(section):
self.set(section, option, str(value))
else:
self.append(section, option, str(value))
def rename(self, section, new_name):
""" Rename a section from configuration
Parameters
----------
section : str
Previous section name
new_name : str
New section name
"""
if self.has_section(section) and not self.has_section(new_name):
for (option, value) in self.items(section):
self.modify(new_name, option, value)
self.remove(section)
def remove(self, section):
""" Remove a section from configuration
Parameters
----------
section : str
Section name
"""
if self.has_section(section):
self.remove_section(section)
def update(self):
""" Write all data from cache into configuration file
This function need to be exec after each modifications to update file
content
"""
with open(self.path, 'w') as pipe:
self.write(pipe)
def add_missing_data(self, path):
""" Append to configuration all missing data from another configuration
Parameters
----------
path : pathlib.Path
Configuration file where to get missing sections/options
Raises
------
OSError
If the configuration filepath not exists
"""
if not path.exists():
raise OSError(2, "Cannot find file", path)
config = Configuration(path)
for section in config.sections():
if not self.has_section(section):
self.add_section(section)
for option in config.options(section):
if not self.has_option(section, option):
self.set(section, option, config.get(section, option))
self.update()Classes
class Configuration (filepath, **kwargs)-
ConfigParser implementing interpolation.
Constructor
Parameters
filepath:strorpathlib.Path- Configuration file path
Expand source code
class Configuration(ConfigParser): def __init__(self, filepath, **kwargs): """ Constructor Parameters ---------- filepath : str or pathlib.Path Configuration file path """ ConfigParser.__init__(self, kwargs) if type(filepath) is not str: raise ValueError("Wrong type for filepath, expected str") # Keep case sensitive for option label self.optionxform = str self.path = Path(filepath).expanduser() if self.path.exists(): self.read(self.path) def __str__(self): """ Formated informations Returns ------- str Formated string """ text = list() for section in sorted(self.sections()): text.append("[%s]" % section) for key in sorted(self.options(section)): text.append("%s = %s" % ( key, self.get(section, key, fallback=str()))) return '\n'.join(text) def item(self, section, option, default=None): """ Return an item from configuration Parameters ---------- section : str Section name option : str Option name default : str, optional Fallback value to return if nothing has been founded (default: None) Returns ------- str or None Value from section option """ if self.has_section(section) and self.has_option(section, option): return self.get(section, option) return default def append(self, section, option, value): """ Append a new section to configuration Parameters ---------- section : str Section name option : str Option name value : str Value to set Raises ------ IndexError If the configuration file not has section """ if self.has_section(section): raise IndexError("Cannot find %s section" % section) self.add_section(section) self.set(section, option, str(value)) def modify(self, section, option, value): """ Modify a section from configuration This function append or update a section into configuration Parameters ---------- section : str Section name option : str Option name value : object Value to set """ # ---------------------------------------- # Specific variables # ---------------------------------------- if type(value) is bool: if value: value = "yes" else: value = "no" elif type(value) is list: value = ' '.join(value) elif value is None: value = str() # ---------------------------------------- # Section # ---------------------------------------- if self.has_section(section): self.set(section, option, str(value)) else: self.append(section, option, str(value)) def rename(self, section, new_name): """ Rename a section from configuration Parameters ---------- section : str Previous section name new_name : str New section name """ if self.has_section(section) and not self.has_section(new_name): for (option, value) in self.items(section): self.modify(new_name, option, value) self.remove(section) def remove(self, section): """ Remove a section from configuration Parameters ---------- section : str Section name """ if self.has_section(section): self.remove_section(section) def update(self): """ Write all data from cache into configuration file This function need to be exec after each modifications to update file content """ with open(self.path, 'w') as pipe: self.write(pipe) def add_missing_data(self, path): """ Append to configuration all missing data from another configuration Parameters ---------- path : pathlib.Path Configuration file where to get missing sections/options Raises ------ OSError If the configuration filepath not exists """ if not path.exists(): raise OSError(2, "Cannot find file", path) config = Configuration(path) for section in config.sections(): if not self.has_section(section): self.add_section(section) for option in config.options(section): if not self.has_option(section, option): self.set(section, option, config.get(section, option)) self.update()Ancestors
- configparser.ConfigParser
- configparser.RawConfigParser
- collections.abc.MutableMapping
- collections.abc.Mapping
- collections.abc.Collection
- collections.abc.Sized
- collections.abc.Iterable
- collections.abc.Container
Methods
def add_missing_data(self, path)-
Append to configuration all missing data from another configuration
Parameters
path:pathlib.Path- Configuration file where to get missing sections/options
Raises
OSError- If the configuration filepath not exists
Expand source code
def add_missing_data(self, path): """ Append to configuration all missing data from another configuration Parameters ---------- path : pathlib.Path Configuration file where to get missing sections/options Raises ------ OSError If the configuration filepath not exists """ if not path.exists(): raise OSError(2, "Cannot find file", path) config = Configuration(path) for section in config.sections(): if not self.has_section(section): self.add_section(section) for option in config.options(section): if not self.has_option(section, option): self.set(section, option, config.get(section, option)) self.update() def append(self, section, option, value)-
Append a new section to configuration
Parameters
section:str- Section name
option:str- Option name
value:str- Value to set
Raises
IndexError- If the configuration file not has section
Expand source code
def append(self, section, option, value): """ Append a new section to configuration Parameters ---------- section : str Section name option : str Option name value : str Value to set Raises ------ IndexError If the configuration file not has section """ if self.has_section(section): raise IndexError("Cannot find %s section" % section) self.add_section(section) self.set(section, option, str(value)) def item(self, section, option, default=None)-
Return an item from configuration
Parameters
section:str- Section name
option:str- Option name
default:str, optional- Fallback value to return if nothing has been founded (default: None)
Returns
strorNone- Value from section option
Expand source code
def item(self, section, option, default=None): """ Return an item from configuration Parameters ---------- section : str Section name option : str Option name default : str, optional Fallback value to return if nothing has been founded (default: None) Returns ------- str or None Value from section option """ if self.has_section(section) and self.has_option(section, option): return self.get(section, option) return default def modify(self, section, option, value)-
Modify a section from configuration
This function append or update a section into configuration
Parameters
section:str- Section name
option:str- Option name
value:object- Value to set
Expand source code
def modify(self, section, option, value): """ Modify a section from configuration This function append or update a section into configuration Parameters ---------- section : str Section name option : str Option name value : object Value to set """ # ---------------------------------------- # Specific variables # ---------------------------------------- if type(value) is bool: if value: value = "yes" else: value = "no" elif type(value) is list: value = ' '.join(value) elif value is None: value = str() # ---------------------------------------- # Section # ---------------------------------------- if self.has_section(section): self.set(section, option, str(value)) else: self.append(section, option, str(value)) def remove(self, section)-
Remove a section from configuration
Parameters
section:str- Section name
Expand source code
def remove(self, section): """ Remove a section from configuration Parameters ---------- section : str Section name """ if self.has_section(section): self.remove_section(section) def rename(self, section, new_name)-
Rename a section from configuration
Parameters
section:str- Previous section name
new_name:str- New section name
Expand source code
def rename(self, section, new_name): """ Rename a section from configuration Parameters ---------- section : str Previous section name new_name : str New section name """ if self.has_section(section) and not self.has_section(new_name): for (option, value) in self.items(section): self.modify(new_name, option, value) self.remove(section) def update(self)-
Write all data from cache into configuration file
This function need to be exec after each modifications to update file content
Expand source code
def update(self): """ Write all data from cache into configuration file This function need to be exec after each modifications to update file content """ with open(self.path, 'w') as pipe: self.write(pipe)