zpp_config 1.2.4__py3-none-any.whl

zpp_config/__init__.py

@@ -0,0 +1,5 @@
+__version__ = '1.2.0'
+__author__ = 'ZephyrOff  (Alexandre Pajak)'
+__descriptor__ = 'Module pour le chargement et la modification de fichier de configuration'
+
+from .config import *

zpp_config/config.py

@@ -0,0 +1,490 @@
+import re
+import ast
+from os.path import isfile, exists
+
+
+class Config():
+	def __init__(self,file,separator=" = ", escape_line="#", auto_create=False, read_only=False):
+		self.reg = r'\[[0-9A-Za-z-_ ]*\]'
+
+		self.separator=separator
+		self.escape_line = escape_line
+
+		self.read_only = read_only
+		self.created = False
+
+		if isfile(file) and exists(file):
+			self.file = file
+		else:
+			if auto_create==False:
+				print("Error: File not exists")
+			else:
+				self.file = file
+				with open(self.file, 'a') as f:
+					pass
+				self.created = True
+
+	#Str to real type
+	def return_data(self, data):
+		if data=="true" or data=="True":
+			return True
+		elif data=="false" or data=="False":
+			return False
+		else:
+			try:
+				 return ast.literal_eval(data)
+			except:
+				return data
+
+
+	def indent_line(self,line):
+		lineC = line.replace("\t","")
+
+		return lineC
+
+
+	def list_section(self):
+		if hasattr(self,'file'):
+			with open(self.file) as f:
+				sec_array = []
+				for line in f.readlines():
+					line = self.indent_line(line.strip())
+					if re.match(self.reg,line):
+						sec_array.append(line.replace("[","").replace("]",""))
+				return sec_array
+
+
+	def load(self,val=None,section=None,default=None):
+		lock=False
+		ban = False
+		data = []
+		sec = ''
+		dict_data = {}
+
+		if hasattr(self,'file'):
+			if section!=None and section!="" and section not in self.list_section():
+				return data
+
+			with open(self.file) as f:
+				for line in f.readlines():
+					line = self.indent_line(line.strip())
+					if ban==True and line.startswith("[") and line.endswith("]"):
+						ban=False
+
+					if line.startswith(self.escape_line+"[") and line.endswith("]"):
+						ban=True
+					elif line.startswith(self.escape_line):
+						pass
+					else:
+						if ban==False:
+							if section!=None:
+								if section!="" and re.match(self.reg,line):
+									if lock==False:
+										if line=="["+section+"]":
+											lock=True
+											data = []
+									else:
+										lock=False
+										break
+
+								else:
+									if lock==True:
+										if len(line)!=0:
+											if val==None:
+												data.append(line)
+											else:
+												line = line.split(self.separator)
+												if line[0]==val:
+													return self.return_data(line[1])
+									elif section=="":
+										if len(line)!=0:
+											if not line.startswith("[") and not line.endswith("]"):
+												if val==None:
+													data.append(line)
+												else:
+													line = line.split(self.separator)
+													if line[0]==val:
+														return self.return_data(line[1])
+											else:
+												break
+
+							elif val!=None:
+								if re.match(self.reg,line):
+									sec = line.replace("[","").replace("]","")
+
+								if len(line)!=0:
+									line = line.split(self.separator)
+									if line[0]==val:
+										data.append(sec + self.separator + line[1])
+
+							else:
+								if len(line)!=0:
+									if not re.match(self.reg,line):
+										line = line.split(self.separator)
+										if sec=='' and sec not in dict_data:
+											dict_data[sec] = {}	
+										dict_data[sec][line[0]] = self.return_data(line[1])
+									else:
+										sec = line.replace("[","").replace("]","")
+										if sec not in dict_data.keys():
+											dict_data[sec] = {}
+
+				if val==None and section==None:
+					return dict_data
+
+
+				if len(data)!=0:
+					for element in data:
+						element=element.split(self.separator)
+						if len(element)>1:
+							dict_data[element[0]] = self.return_data(element[1])
+
+					if dict_data=={} and default!=None:
+						return default
+					else:
+						return dict_data
+						
+				if data==[] and default!=None:
+					return default
+				else:
+					return data
+		
+		if default!=None:
+			return default
+
+
+	def edit(self,line,val,key,temp):
+		if len(line)!=0:
+			if val!=None:
+				lineT = line.split(self.separator)
+				if lineT[0]==val:
+					self.new_content.append(temp.replace(self.separator+lineT[1], self.separator+str(key)))
+					return True
+				else:
+					self.new_content.append(temp)
+					return True
+		return False
+
+
+	def change(self,val=None,key=None,section=None):
+		if self.read_only==False:
+			if val!=None and key!=None:
+				if isinstance(key,str) or isinstance(key,list) or isinstance(key,int) or isinstance(key,float) or isinstance(key,bool) or isinstance(key,dict):
+					if hasattr(self,'file'):
+						with open(self.file) as f:
+							self.new_content = []
+							lock=False
+
+							for line in f.readlines():
+								temp = line.rstrip()
+								line = self.indent_line(line.strip())
+								if len(line)!=0:
+									if section!=None:
+										if section!="" and re.match(self.reg,line):
+											if lock==False:
+												if line=="["+section+"]":
+													lock=True
+											else:
+												lock=False
+
+										else:
+											if lock==True:
+												if self.edit(line,val,key,temp):
+													continue
+									else:
+										if self.edit(line,val,key,temp):
+											continue
+
+									self.new_content.append(temp)
+								else:
+									self.new_content.append(temp)
+						
+						with open(self.file,"w") as f:
+							f.write("\n".join(self.new_content))
+		else:
+			print("Read-only mode")
+
+
+	def add(self,val=None,key=None,section=None):
+		if self.read_only==False:
+			exist = True
+			new_content=None
+			lock=False
+
+			if key=="":
+				key = '""'
+
+			if hasattr(self,'file'):
+				if section!=None and section!="" and section not in self.list_section():
+					exist = False
+
+				if val!=None and val!="" and key!=None and not (isinstance(key,str) or isinstance(key,list) or isinstance(key,int) or isinstance(key,float) or isinstance(key,bool) or isinstance(key,dict)):
+					print("Key not supported")
+					return
+
+				with open(self.file) as f:
+					if exist==False:
+						new_content=f.read()
+						if len(new_content):
+							if new_content[len(new_content)-1]=="\n":
+								new_content+="\n["+section+"]"
+							else:
+								new_content+="\n\n["+section+"]"
+						else:
+							new_content="["+section+"]"							
+						
+						if val!=None and val!="" and key!=None:
+							new_content+="\n"+val+self.separator+str(key)
+
+					else:
+						data = self.load()
+						if not len(data):
+							data = {"":{}}
+						if section!=None:
+							se_test = section
+						else:
+							se_test = ""
+
+						if val!=None:
+							se = data[se_test]
+							if val in se.keys():
+								print("Key already exist")
+								return
+
+						if val!=None and val!="" and key!=None:
+							if section=="" or section==None:
+								new_content=val+self.separator+str(key)+"\n"
+								new_content+=f.read()
+							else:
+								new_content = []
+								for line in f.readlines():
+									line_temp = line.rstrip()
+									line = self.indent_line(line.strip())
+									if line_temp!="":
+										if section!=None:
+											if section!="" and re.match(self.reg,line):
+												if lock==False:
+													if line=="["+section+"]":
+														if len(se.keys())==0:
+															line_temp+="\n"+val+self.separator+str(key)
+														lock=True
+												else:
+													lock=False
+
+											else:
+												if lock==True:
+													if "\t" in line_temp:
+														line_temp+="\n"+("\t"*line_temp.count('\t'))+val+self.separator+str(key)
+														lock=False
+													
+									new_content.append(line_temp)
+
+								new_content = "\n".join(new_content)
+
+				if new_content!=None:
+					with open(self.file,'w') as f:
+						f.write(new_content)
+		else:
+			print("Read-only mode")
+
+
+	def delete(self,val=None,section=None):
+		if self.read_only==False:
+			if hasattr(self,'file'):
+				with open(self.file) as f:
+					lock=False
+					new_content=""
+					sec = ""
+					ban=False
+
+					for line in f.readlines():
+						lineT = line
+						line = self.indent_line(line.strip())
+
+						if line.startswith("[") and line.endswith("]"):
+							ban=False
+							sec = line.replace("[","").replace("]","")
+
+						elif line.startswith(self.escape_line+"[") and line.endswith("]"):
+							ban=True
+							sec = line.replace(self.escape_line+"[","").replace("]","")
+
+						if ban!=True:
+							if section!=None and section!="":
+								if section!="" and re.match(self.reg,line):
+									if lock==False:
+										if line=="["+section+"]":
+											lock=True
+											if val!=None:
+												new_content+=lineT	
+										else:
+											new_content+=lineT	
+									else:
+										new_content+=lineT	
+										lock=False
+								else:
+									if lock==True:
+										if val==None:
+											pass
+										else:
+											line = line.split(self.separator)
+											if line[0]==val:
+												pass
+											else:
+												new_content+=lineT
+									else:
+										new_content+=lineT
+							else:
+								if val!=None and sec=="":
+									line = line.split(self.separator)
+									if line[0]==val:
+										pass
+									else:
+										new_content+=lineT
+								else:
+									new_content+=lineT
+						else:
+							new_content+=lineT
+
+					if new_content!="":
+						with open(self.file,'w') as f:
+							f.write(new_content)
+		else:
+			print("Read-only mode")
+
+
+	def disabled_line(self, section=None):
+		dict_data = {}
+		
+		if hasattr(self,'file'):
+			with open(self.file) as f:
+				ban=False
+				sec = ""
+
+				for line in f.readlines():
+					line = self.indent_line(line.strip())
+					if len(line)!=0:
+						if line.startswith("[") and line.endswith("]"):
+							sec = line.replace("[","").replace("]","")
+							if ban==True:
+								ban=False
+
+						if line.startswith(self.escape_line+"[") and line.endswith("]"):
+							ban=True
+							sec = line.replace(self.escape_line+"[","").replace("]","")
+
+						elif line.startswith(self.escape_line):
+							line = line[1:len(line)].split(self.separator)
+							if sec not in dict_data.keys():
+								dict_data[sec] = {}
+							dict_data[sec][line[0]] = self.return_data(line[1])
+
+						else:
+							if ban==True:
+								line = line.split(self.separator)
+								if sec not in dict_data.keys():
+									dict_data[sec] = {}
+								dict_data[sec][line[0]] = self.return_data(line[1])
+		return dict_data
+
+	def disable(self,val=None,section=None):
+		if self.read_only==False:
+			if val!=None:
+				if hasattr(self,'file'):
+					modified = False
+					with open(self.file) as f:
+						self.new_content = []
+						lock=False
+
+						for line in f.readlines():
+							temp = line.rstrip()
+							line = self.indent_line(line.strip())
+							if len(line)!=0:
+								if section!=None:
+									if section!="" and re.match(self.reg,line):
+										if lock==False:
+											if line=="["+section+"]":
+												lock=True
+										else:
+											lock=False
+									else:
+										if lock==True:
+											lineT = line.split(self.separator)
+											if lineT[0]==val:
+												modified = True
+												self.new_content.append("#"+line)
+											else:
+												self.new_content.append(line)
+											continue
+								else:
+									lineT = line.split(self.separator)
+									if lineT[0]==val:
+										modified = True
+										self.new_content.append("#"+line)
+									else:
+										self.new_content.append(line)
+									continue
+								self.new_content.append(temp)
+							else:
+								self.new_content.append(temp)
+					
+					if modified:
+						with open(self.file,"w") as f:
+							f.write("\n".join(self.new_content))
+						return True
+					return False
+		else:
+			print("Read-only mode")
+			return False
+
+
+	def enable(self,val=None,section=None):
+		if self.read_only==False:
+			if val!=None:
+				val = "#"+val
+				if hasattr(self,'file'):
+					modified = False
+					with open(self.file) as f:
+						self.new_content = []
+						lock=False
+
+						for line in f.readlines():
+							temp = line.rstrip()
+							line = self.indent_line(line.strip())
+							if len(line)!=0:
+								if section!=None:
+									if section!="" and re.match(self.reg,line):
+										if lock==False:
+											if line=="["+section+"]":
+												lock=True
+										else:
+											lock=False
+									else:
+										if lock==True:
+											lineT = line.split(self.separator)
+											if lineT[0]==val:
+												modified = True
+												self.new_content.append(line[1:])
+											else:
+												self.new_content.append(line)
+											continue
+								else:
+									lineT = line.split(self.separator)
+									if lineT[0]==val:
+										modified = True
+										self.new_content.append(line[1:])
+									else:
+										self.new_content.append(line)
+									continue
+								self.new_content.append(temp)
+							else:
+								self.new_content.append(temp)
+					
+					if modified:
+						with open(self.file,"w") as f:
+							f.write("\n".join(self.new_content))
+						return True
+					return False
+		else:
+			print("Read-only mode")
+			return False

zpp_config-1.2.4.dist-info/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 ZephyrOff  (Alexandre Pajak)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

zpp_config-1.2.4.dist-info/METADATA

@@ -0,0 +1,164 @@
+Metadata-Version: 2.1
+Name: zpp_config
+Version: 1.2.4
+Summary: Module pour le chargement et la modification de fichier de configuration
+Home-page: https://github.com/ZephyrOff/py-zpp_config
+Author: 
+License: MIT License
+Project-URL: Documentation, https://github.com/ZephyrOff/py-zpp_config
+Keywords: config file terminal zephyroff
+Platform: ALL
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Environment :: Console
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Description-Content-Type: text/markdown
+License-File: LICENSE
+
+# zpp-config
+## Informations
+Librairie pour l'utilisation et la modification de fichier de configuration:<br>
+- Charger un ou plusieurs paramètres
+- Modifier un paramètre existant
+- Ajout un paramètre ou une section
+- Supprimer un paramètre ou une section
+- Lister les sections disponibles
+- Lister les paramètres et/ou sections désactivés
+
+Prends en compte les paramètres commentés.<br>
+Compatible avec les fichiers de configuration indentés.<br><br>
+Traduit les paramètres pour les types str, int, float, bool, list, dict
+
+### Prérequis
+- Python 3
+<br>
+
+# Installation
+```console
+pip install zpp_config
+```
+
+# Utilisation
+### Conseil d'importation du module
+```python
+from zpp_config import Config
+```
+
+<br>
+
+### Exemple de fichier de config
+```xml
+[section]
+	value1 = key1
+	value2 = key2
+	value3 = key3
+
+[section2]
+	value1 = key1
+	value2 = key2
+	value3 = key3
+```
+
+<br>
+
+### Initialisaton d'un fichier de configuration
+```python
+c = Config("conf.ini")
+```
+>En paramètre supplémentaire, nous pouvons mettre:<br/>
+>- separator: Définir le séparateur entre la clé et la valeur dans le fichier. (Par défaut: " = ") 
+>- escape_line: Définir le caractère utilisé pour commenter une valeur ou une section. (Par défaut: "#")
+>- auto_create: Créer le fichier de configuration s'il n'existe pas. (Par défaut: "False")
+>- read_only: Ouvrir le fichier de configuration en lecture seule. (Par défaut: "False")
+
+<br>
+
+### Chargement de paramètre
+
+La fonction renvoie la valeur si un unique paramètre a été trouvé, sinon renvoie un dictionnaire avec les différentes valeurs trouvées (classé par section)
+Renvoie un tableau vide si aucun paramètre n'a été trouvé
+
+#### Chargement de tous les paramètres
+```python
+data = c.load()
+```
+#### Chargement d'une section du fichier
+```python
+data = c.load(section='section_name')
+```
+#### Chargement d'une valeur dans tout le fichier
+```python
+data = c.load(val='value_name')
+```
+#### Chargement d'une valeur dans une section spécifique
+```python
+data = c.load(val='value_name', section='section_name')
+```
+
+>En paramètre supplémentaire, nous pouvons mettre:<br/>
+>- default: Pour initialiser une valeur par défaut si aucun résultat est trouvé 
+
+
+<br>
+
+### Changement de paramètre
+#### Changement d'une valeur dans tout le fichier
+```python
+c.change(val='value_name', key='key_value')
+```
+
+#### Changement d'une valeur dans une section spécifique
+```python
+c.change(val='value_name', key='key_value', section='section_name')
+```
+
+<br>
+
+### Ajout de paramètre ou de section
+
+Ajoute une section ou un paramètre dans le fichier de configuration.
+Dans le cas de l'ajout d'un paramètre, rajoute la section si elle n'existe pas.
+
+#### Ajout d'une section
+```python
+c.add(section='section_name')
+```
+
+#### Ajout d'un paramètre dans une section
+```python
+c.add(val='value_name', key='key_value', section='section_name')
+```
+> Si aucune section est défini, rajoute le paramètre en dehors des sections.
+
+<br>
+
+### Suppression de paramètre ou de section
+
+#### Suppression d'une section
+```python
+c.delete(section='section_name')
+```
+
+#### Suppression d'un paramètre dans une section
+```python
+c.delete(val='value_name', section='section_name')
+```
+> Si aucune section est défini, recherche le paramètre en dehors des sections.
+
+<br>
+
+### Liste des paramètres non pris en compte
+
+Retourne la liste des paramètres qui sont non pris en compte dans le fichier de configuration.
+
+```python
+data = c.disabled_line()
+```
+> Possibilité de préciser la section en utilisant le paramètre section
+
+<br>
+
+### Liste les sections disponibles
+```python
+data = c.list_section()
+```

zpp_config-1.2.4.dist-info/RECORD

@@ -0,0 +1,7 @@
+zpp_config/__init__.py,sha256=fYbK3e8kVMyChmsTKxh3Sipa0P1PVeSmBctW3c86vII,184
+zpp_config/config.py,sha256=LdioFZFd5o-q4GRs6V_TzpwABaXgi20aSxXI6rVQp30,13211
+zpp_config-1.2.4.dist-info/LICENSE,sha256=IN5ZiLY3uHlCdy7WDkFpEPZZYO6hZWelnfxjFcyJ1tc,1106
+zpp_config-1.2.4.dist-info/METADATA,sha256=M9N8RiStdFsqb5mqq24mettuemcXIjEM0k8L0XdEQ_s,4529
+zpp_config-1.2.4.dist-info/WHEEL,sha256=Z4pYXqR_rTB7OWNDYFOm1qRk0RX6GFP2o8LgvP453Hk,91
+zpp_config-1.2.4.dist-info/top_level.txt,sha256=6dEIAXeo-7VTDVRECIf2Jl3e1icUn_HS6ht6H4QYd9o,11
+zpp_config-1.2.4.dist-info/RECORD,,

zpp_config-1.2.4.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (70.3.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

zpp_config-1.2.4.dist-info/top_level.txt

@@ -0,0 +1 @@
+zpp_config