xmipp3-installer 1.0.0__py3-none-any.whl → 1.1.0__py3-none-any.whl

xmipp3_installer/repository/config.py

@@ -12,230 +12,228 @@ from xmipp3_installer.repository.config_vars import default_values, variables, c
 from xmipp3_installer.repository.invalid_config_line import InvalidConfigLineError
 
 class ConfigurationFileHandler(Singleton):
-	"""
-	### Configuration file class for loading and storing the installation configuration.
-	"""
-	__COMMENT_ESCAPE = '#'
-	__ASSIGNMENT_SEPARATOR = '='
-	__LAST_MODIFIED_TEXT = "Config file automatically generated on"
-
-	def __init__(self, path: str=paths.CONFIG_FILE, show_errors: bool=True):
-		"""
-		### Constructor.
-		
-		#### Params:
-		- path (str): Optional. Path to the configuration file.
-		"""
-		self.__path = path
-		self.show_errors = show_errors
-		self.values = {}
-		self.read_config()
-		self.last_modified = self.__read_config_date()
-
-	def read_config(self):
-		"""
-		### Reads the config file and stores a dictionary with all the parsed variables.
-		"""
-		file_lines = self.__get_file_content()
-		result = {}
-		for line_number, line in enumerate(file_lines):
-			new_result = self.__add_line_values(result.copy(), line, line_number + 1)
-			if new_result is None:
-				result = {}
-				break
-			result = new_result
-		self.values = {
-			**config_values_adapter.get_context_values_from_file_values(
-				default_values.CONFIG_DEFAULT_VALUES
-			),
-			**config_values_adapter.get_context_values_from_file_values(
-				result,
-				show_warnings=self.show_errors
-			)
-		}
-
-	def write_config(self, overwrite: bool=False):
-		"""
-		### Writes a template config file with stored variables, leaving the rest with default values.
-
-		#### Params:
-		- overwrite (bool): Optional. If True, default values are written, overwriting the existing file.
-		"""
-		if overwrite:
-			self.values = default_values.CONFIG_DEFAULT_VALUES
-		values = config_values_adapter.get_file_values_from_context_values(self.values.copy())
-		self.last_modified = datetime.today().strftime('%d-%m-%Y %H:%M.%S')
-		
-		lines = ["##### TOGGLE SECTION #####\n"]
-		lines.append(f"# Activate or deactivate this features using values {default_values.ON}/{default_values.OFF}\n")
-		lines.extend(self.__get_section_lines(variables.TOGGLES, values))
-
-		lines.append("\n##### PACKAGE HOME SECTION #####\n")
-		lines.append("# Use this variables to use custom installation paths for the required packages.\n")
-		lines.append("# If left empty, CMake will search for those packages within your system.\n")
-		lines.extend(self.__get_section_lines(variables.LOCATIONS, values))
-		
-		lines.append("\n##### COMPILATION FLAGS #####\n")
-		lines.append("# We recommend not modifying this variables unless you know what you are doing.\n")
-		lines.extend(self.__get_section_lines(variables.COMPILATION_FLAGS, values))
-		
-		if values:
-			lines.append("\n##### UNKNOWN VARIABLES #####\n")
-			lines.append("# This variables were not expected, but are kept here in case they might be needed.\n")
-			lines.extend(self.__get_unkown_variable_lines(values))
-
-		lines.append(f"\n# {self.__LAST_MODIFIED_TEXT} {self.last_modified}\n")
-		with open(self.__path, 'w') as config_file:
-			config_file.writelines(lines)
-
-	def get_config_date(self) -> str:
-		"""
-		### Returns the date of the last modification of the configuration file.
-
-		#### Returns:
-		- (str): Date in dd-mm-yyyy format.
-		"""
-		if not self.last_modified:
-			self.last_modified = self.__read_config_date()
-		return self.last_modified
-		
-	def __get_file_content(self) -> List[str]:
-		"""
-		### Reads the whole unparsed content of the given file.
-
-		#### Returns:
-		- (list(str)): Content of the file, where each line is a string in the result list.
-		"""
-		if not os.path.exists(self.__path):
-			return []
-		lines = []
-		with open(self.__path, "r") as config_file:
-			lines = config_file.readlines()
-		return lines
-
-	def __read_config_date(self) -> str:
-		"""
-		### Reads from the config file the date of its last modification.
-
-		#### Returns:
-		- (str): Date in dd-mm-yyyy format.
-		"""
-		config_lines = self.__get_file_content()
-		for line in config_lines:
-			if self.__LAST_MODIFIED_TEXT not in line:
-				continue
-			match = re.search(r'\d{2}-\d{2}-\d{4} \d{2}:\d{2}.\d{2}', line)
-			if match:
-				return match.group()
-		return ""
-
-	def __add_line_values(self, config: Dict, line: str, line_number: int) -> Optional[Dict]:
-		"""
-		### Adds the config values present in the current line to the given dictionary.
-
-		#### Params:
-		- config (dict): Dictionary with all the present variables.
-		- line (str): Current line to extract values from.
-		- line_number (int): Line index in the list of lines that compose the file.
-
-		#### Returns:
-		- (dict | None): An updated dictionary with the newly obtained variable, or None if there was an error.
-		"""
-		try:
-			key_value_pair = self.__parse_config_line(line, line_number)
-		except InvalidConfigLineError as error:
-			if self.show_errors:
-				logger(str(error))
-			config = {}
-			return
-		if key_value_pair:
-			key, value = key_value_pair
-			config[key] = value
-		return config
-
-	def __parse_config_line(self, line: str, line_number: int) -> Optional[Tuple[str, str]]:
-		"""
-		### Reads the given line from the config file and returns the key-value pair as a tuple.
-
-		#### Params:
-		- line_number (int): Line number inside the config file.
-		- line (str): Line to parse.
-		
-		#### Returns:
-		- (tuple(str, str) | None): Tuple containing the read key-value pair if line contains valid data.
-
-		#### Raises:
-		- RuntimeError: Raised when a line has an invalid format and cannot be parsed.
-		"""
-		line_without_comments = line.split(self.__COMMENT_ESCAPE, maxsplit=2)[0].strip()
-		if not line_without_comments:
-			return None
-		
-		tokens = line_without_comments.split(self.__ASSIGNMENT_SEPARATOR, maxsplit=1)
-		if len(tokens) != 2:
-			raise InvalidConfigLineError(
-				InvalidConfigLineError.generate_error_message(
-					paths.CONFIG_FILE,
-					line_number,
-					line
-				)
-			)
-		
-		return tokens[0].strip(), tokens[1].strip()
-
-	def __make_config_line(self, key: str, value: str, default_value: str) -> str:
-		"""
-		### Composes a config file line given a key-value pair to write.
-
-		#### Params:
-		- key (int): Name of the variable.
-		- value (str): Value of the variable found in the config file.
-		- default_value (str): Default value of the variable.
-		
-		#### Returns:
-		- (str): String containing the appropiately formatted key-value pair.
-		"""
-		default_value = '' if default_value is None else default_value
-		value = default_value if value is None else value
-		return f"{key}{self.__ASSIGNMENT_SEPARATOR}{value}" if key else ""
-
-	def __get_section_lines(self, section_type: str, config_variables: Dict[str, Any]) -> List[str]:
-		"""
-		### Returns the lines composed by the given section's variables in the dictionary, and deletes them from it.
-
-		#### Params:
-		- section_type (str): Section to extract variables from.
-		- config_variables (dict(str, any)): Dictionary containing all variables.
-
-		#### Returns:
-		- (list(str)): Config file lines created from the dictionary variables.
-		"""
-		lines = []
-		for section_variable in variables.CONFIG_VARIABLES[section_type]:
-			lines.append(''.join([
-				self.__make_config_line(
-					section_variable,
-					config_variables.get(section_variable),
-					default_values.CONFIG_DEFAULT_VALUES[section_variable]
-				),
-				"\n"
-			]))
-			config_variables.pop(section_variable, None)
-		return lines
-
-	def __get_unkown_variable_lines(self, config_variables: Dict[str, Any]) -> List[str]:
-		"""
-		### Returns the lines composed by the unkown variables in the dictionary.
-
-		#### Params:
-		- config_variables (dict(str, any)): Dictionary containing all unknown variables.
-
-		#### Returns:
-		- (list(str)): Config file lines created from the dictionary variables.
-		"""
-		lines = []
-		for variable in config_variables.keys():
-			lines.append(
-				f"{self.__make_config_line(variable, config_variables[variable], '')}\n"
-			)
-		return lines
+  """### Configuration file class for loading and storing the installation configuration."""
+
+  __COMMENT_ESCAPE = '#'
+  __ASSIGNMENT_SEPARATOR = '='
+  __LAST_MODIFIED_TEXT = "Config file automatically generated on"
+
+  def __init__(self, path: str=paths.CONFIG_FILE, show_errors: bool=True):
+    """
+    ### Constructor.
+    
+    #### Params:
+    - path (str): Optional. Path to the configuration file.
+    """
+    self.__path = path
+    self.show_errors = show_errors
+    self.values = {}
+    self.read_config()
+    self.last_modified = self.__read_config_date()
+
+  def read_config(self):
+    """### Reads the config file and stores a dictionary with all the parsed variables."""
+    file_lines = self.__get_file_content()
+    result = {}
+    for line_number, line in enumerate(file_lines):
+      new_result = self.__add_line_values(result.copy(), line, line_number + 1)
+      if new_result is None:
+        result = {}
+        break
+      result = new_result
+    self.values = {
+      **config_values_adapter.get_context_values_from_file_values(
+        default_values.CONFIG_DEFAULT_VALUES
+      ),
+      **config_values_adapter.get_context_values_from_file_values(
+        result,
+        show_warnings=self.show_errors
+      )
+    }
+
+  def write_config(self, overwrite: bool=False):
+    """
+    ### Writes a template config file with stored variables, leaving the rest with default values.
+
+    #### Params:
+    - overwrite (bool): Optional. If True, default values are written, overwriting the existing file.
+    """
+    if overwrite:
+      self.values = config_values_adapter.get_context_values_from_file_values(default_values.CONFIG_DEFAULT_VALUES)
+    values = config_values_adapter.get_file_values_from_context_values(self.values.copy())
+    self.last_modified = datetime.today().strftime('%d-%m-%Y %H:%M.%S')
+    
+    lines = ["##### TOGGLE SECTION #####\n"]
+    lines.append(f"# Activate or deactivate this features using values {default_values.ON}/{default_values.OFF}\n")
+    lines.extend(self.__get_section_lines(variables.TOGGLES, values))
+
+    lines.append("\n##### PACKAGE HOME SECTION #####\n")
+    lines.append("# Use this variables to use custom installation paths for the required packages.\n")
+    lines.append("# If left empty, CMake will search for those packages within your system.\n")
+    lines.extend(self.__get_section_lines(variables.LOCATIONS, values))
+    
+    lines.append("\n##### COMPILATION FLAGS #####\n")
+    lines.append("# We recommend not modifying this variables unless you know what you are doing.\n")
+    lines.extend(self.__get_section_lines(variables.COMPILATION_FLAGS, values))
+    
+    if values:
+      lines.append("\n##### UNKNOWN VARIABLES #####\n")
+      lines.append("# This variables were not expected, but are kept here in case they might be needed.\n")
+      lines.extend(self.__get_unkown_variable_lines(values))
+
+    lines.append(f"\n# {self.__LAST_MODIFIED_TEXT} {self.last_modified}\n")
+    with open(self.__path, 'w', encoding="utf-8") as config_file:
+      config_file.writelines(lines)
+
+  def get_config_date(self) -> str:
+    """
+    ### Returns the date of the last modification of the configuration file.
+
+    #### Returns:
+    - (str): Date in dd-mm-yyyy format.
+    """
+    if not self.last_modified:
+      self.last_modified = self.__read_config_date()
+    return self.last_modified
+    
+  def __get_file_content(self) -> List[str]:
+    """
+    ### Reads the whole unparsed content of the given file.
+
+    #### Returns:
+    - (list(str)): Content of the file, where each line is a string in the result list.
+    """
+    if not os.path.exists(self.__path):
+      return []
+    lines = []
+    with open(self.__path, encoding="utf-8") as config_file:
+      lines = config_file.readlines()
+    return lines
+
+  def __read_config_date(self) -> str:
+    """
+    ### Reads from the config file the date of its last modification.
+
+    #### Returns:
+    - (str): Date in dd-mm-yyyy format.
+    """
+    config_lines = self.__get_file_content()
+    for line in config_lines:
+      if self.__LAST_MODIFIED_TEXT not in line:
+        continue
+      match = re.search(r'\d{2}-\d{2}-\d{4} \d{2}:\d{2}.\d{2}', line)
+      if match:
+        return match.group()
+    return ""
+
+  def __add_line_values(self, config: Dict, line: str, line_number: int) -> Optional[Dict]:
+    """
+    ### Adds the config values present in the current line to the given dictionary.
+
+    #### Params:
+    - config (dict): Dictionary with all the present variables.
+    - line (str): Current line to extract values from.
+    - line_number (int): Line index in the list of lines that compose the file.
+
+    #### Returns:
+    - (dict | None): An updated dictionary with the newly obtained variable, or None if there was an error.
+    """
+    try:
+      key_value_pair = self.__parse_config_line(line, line_number)
+    except InvalidConfigLineError as error:
+      if self.show_errors:
+        logger(str(error))
+      config = {}
+      return
+    if key_value_pair:
+      key, value = key_value_pair
+      config[key] = value
+    return config
+
+  def __parse_config_line(self, line: str, line_number: int) -> Optional[Tuple[str, str]]:
+    """
+    ### Reads the given line from the config file and returns the key-value pair as a tuple.
+
+    #### Params:
+    - line_number (int): Line number inside the config file.
+    - line (str): Line to parse.
+    
+    #### Returns:
+    - (tuple(str, str) | None): Tuple containing the read key-value pair if line contains valid data.
+
+    #### Raises:
+    - RuntimeError: Raised when a line has an invalid format and cannot be parsed.
+    """
+    N_TOKENS = 2
+    line_without_comments = line.split(self.__COMMENT_ESCAPE, maxsplit=2)[0].strip()
+    if not line_without_comments:
+      return None
+    
+    tokens = line_without_comments.split(self.__ASSIGNMENT_SEPARATOR, maxsplit=1)
+    if len(tokens) != N_TOKENS:
+      raise InvalidConfigLineError(
+        InvalidConfigLineError.generate_error_message(
+          paths.CONFIG_FILE,
+          line_number,
+          line
+        )
+      )
+    
+    return tokens[0].strip(), tokens[1].strip()
+
+  def __make_config_line(self, key: str, value: Optional[str], default_value: str) -> str:
+    """
+    ### Composes a config file line given a key-value pair to write.
+
+    #### Params:
+    - key (int): Name of the variable.
+    - value (str | None): Value of the variable found in the config file.
+    - default_value (str): Default value of the variable.
+    
+    #### Returns:
+    - (str): String containing the appropiately formatted key-value pair.
+    """
+    default_value = '' if default_value is None else default_value
+    value = default_value if value is None else value
+    return f"{key}{self.__ASSIGNMENT_SEPARATOR}{value}" if key else ""
+
+  def __get_section_lines(self, section_type: str, config_variables: Dict[str, str]) -> List[str]:
+    """
+    ### Returns the lines composed by the given section's variables in the dictionary, and deletes them from it.
+
+    #### Params:
+    - section_type (str): Section to extract variables from.
+    - config_variables (dict(str, str)): Dictionary containing all variables.
+
+    #### Returns:
+    - (list(str)): Config file lines created from the dictionary variables.
+    """
+    lines = []
+    for section_variable in variables.CONFIG_VARIABLES[section_type]:
+      lines.append(''.join([
+        self.__make_config_line(
+          section_variable,
+          config_variables.get(section_variable),
+          default_values.CONFIG_DEFAULT_VALUES[section_variable]
+        ),
+        "\n"
+      ]))
+      config_variables.pop(section_variable, None)
+    return lines
+
+  def __get_unkown_variable_lines(self, config_variables: Dict[str, Any]) -> List[str]:
+    """
+    ### Returns the lines composed by the unkown variables in the dictionary.
+
+    #### Params:
+    - config_variables (dict(str, any)): Dictionary containing all unknown variables.
+
+    #### Returns:
+    - (list(str)): Config file lines created from the dictionary variables.
+    """
+    lines = []
+    for variable_name, value in config_variables.items():
+      lines.append(
+        f"{self.__make_config_line(variable_name, value, '')}\n"
+      )
+    return lines

xmipp3_installer/repository/config_vars/__init__.py

@@ -0,0 +1,5 @@
+"""
+### Configuration Variables Module.
+
+This module contains configuration variables used throughout the application.
+"""