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

xmipp3_installer/application/logger/logger.py

@@ -1,6 +1,5 @@
 """### Provides a global logger."""
 
-import math
 import shutil
 from io import BufferedReader
 
@@ -9,221 +8,225 @@ from xmipp3_installer.application.logger import errors
 from xmipp3_installer.installer import urls
 
 class Logger(Singleton):
-	"""
-	### Logger class for keeping track of installation messages.
-	"""
-	__UP = "\x1B[1A\r"
-	__REMOVE_LINE = '\033[K'
-	__BOLD = "\033[1m"
-	__BLUE = "\033[34m"
-	__RED = "\033[91m"
-	__GREEN = "\033[92m"
-	__YELLOW = "\033[93m"
-	__END_FORMAT = "\033[0m"
-	__FORMATTING_CHARACTERS = [__UP, __REMOVE_LINE, __BOLD, __BLUE, __RED, __GREEN, __YELLOW, __END_FORMAT]
+  """### Logger class for keeping track of installation messages."""
+
+  __UP = "\x1B[1A\r"
+  __REMOVE_LINE = '\033[K'
+  __BOLD = "\033[1m"
+  __BLUE = "\033[34m"
+  __RED = "\033[91m"
+  __GREEN = "\033[92m"
+  __YELLOW = "\033[93m"
+  __END_FORMAT = "\033[0m"
+  __FORMATTING_CHARACTERS = [__UP, __REMOVE_LINE, __BOLD, __BLUE, __RED, __GREEN, __YELLOW, __END_FORMAT]
  
-	def __init__(self):
-		"""
-		### Constructor.
-		
-		#### Params:
-		- ouputToConsoloe (bool): Print messages to console.
-		"""
-		self.__log_file = None
-		self.__len_last_printed_elem = 0
-		self.__allow_substitution = True
-	
-	def green(self, text: str) -> str:
-		"""
-		### This function returns the given text formatted in green color.
-
-		#### Params:
-		- text (str): Text to format.
-
-		#### Returns:
-		- (str): Text formatted in green color.
-		"""
-		return self.__format_text(text, self.__GREEN)
-
-	def yellow(self, text: str) -> str:
-		"""
-		### This function returns the given text formatted in yellow color.
-
-		#### Params:
-		- text (str): Text to format.
-
-		#### Returns:
-		- (str): Text formatted in yellow color.
-		"""
-		return self.__format_text(text, self.__YELLOW)
-
-	def red(self, text: str) -> str:
-		"""
-		### This function returns the given text formatted in red color.
-
-		#### Params:
-		- text (str): Text to format.
-
-		#### Returns:
-		- (str): Text formatted in red color.
-		"""
-		return self.__format_text(text, self.__RED)
-
-	def blue(self, text: str) -> str:
-		"""
-		### This function returns the given text formatted in blue color.
-
-		#### Params:
-		- text (str): Text to format.
-
-		#### Returns:
-		- (str): Text formatted in blue color.
-		"""
-		return self.__format_text(text, self.__BLUE)
-
-	def bold(self, text: str) -> str:
-		"""
-		### This function returns the given text formatted in bold.
-
-		#### Params:
-		- text (str): Text to format.
-
-		#### Returns:
-		- (str): Text formatted in bold.
-		"""
-		return self.__format_text(text, self.__BOLD)
-
-	def start_log_file(self, log_path: str):
-		"""
-		### Initiates the log file.
-
-		#### Params:
-		- log_path (str): Path to the log file.
-		"""
-		if self.__log_file is None:
-			self.__log_file = open(log_path, 'w')
-
-	def close(self):
-		"""
-		### Closes the log file.
-		"""
-		if self.__log_file:
-			self.__log_file.close()
-			self.__log_file = None
-
-	def set_allow_substitution(self, allow_substitution: bool):
-		"""
-		### Modifies console output behaviour, allowing or disallowing substitutions.
-		
-		#### Params:
-		- allow_substitution (bool): If False, console outputs won't be substituted.
-		"""
-		self.__allow_substitution = allow_substitution
-
-	def __call__(self, text: str, show_in_terminal: bool=True, substitute: bool=False):
-		"""
-		### Log a message.
-		
-		#### Params:
-		- text (str): Message to be logged. Supports fancy formatting.
-		- show_in_terminal (bool): Optional. If True, text is also printed through terminal.
-		- substitute (bool): Optional. If True, previous line is substituted with new text. Only used when show_in_terminal = True.
-		"""
-		if self.__log_file is not None:
-			print(self.__remove_non_printable(text), file=self.__log_file, flush=True)
-			
-		if show_in_terminal:
-			text = self.__substitute_lines(text) if self.__allow_substitution and substitute else text
-			print(text, flush=True)
-			# Store length of printed string for next substitution calculation
-			self.__len_last_printed_elem = len(self.__remove_non_printable(text))
-	 
-	def log_error(self, error_msg: str, ret_code: int=1, add_portal_link: bool=True):
-		"""
-		### Prints an error message.
-
-		#### Params:
-		- error_msg (str): Error message to show.
-		- ret_code (int): Optional. Return code to end the exection with.
-		- add_portal_link (bool): If True, a message linking the documentation portal is shown.
-		"""
-		error = errors.ERROR_CODES.get(ret_code, errors.ERROR_CODES[errors.UNKOW_ERROR])
-		error_str = error_msg + '\n\n' if error_msg else ''
-		error_str += f'Error {ret_code}: {error[0]}'
-		error_str += f"\n{error[1]}" if error[1] else ''
-		if add_portal_link:
-			error_str += f'\nMore details on the Xmipp documentation portal: {urls.DOCUMENTATION_URL}'
-
-		self.__call__(self.red(error_str), show_in_terminal=True)
-
-	def log_in_streaming(self, stream: BufferedReader, show_in_terminal: bool=False, substitute: bool=False, err: bool=False):
-		"""
-		### Receives a process output stream and logs its lines.
-
-		#### Params:
-		- stream (BufferedReader): Function to run.
-		- show_in_terminal (bool): Optional. If True, output will also be printed through terminal.
-		- substitute (bool): Optional. If True, output will replace previous line. Only used when show is True.
-		- err (bool): Optional. If True, the stream contains an error. Otherwise, it is regular output.
-		"""
-		if show_in_terminal and self.__allow_substitution and substitute:
-			print("")
-		
-		for line in iter(stream.readline, b''):
-			line = line.decode().replace("\n", "")
-			if err:
-				line = self.red(line)
-			self.__call__(line, show_in_terminal=show_in_terminal, substitute=substitute)
-
-	def __remove_non_printable(self, text: str) -> str:
-		"""
-		### This function returns the given text without non printable characters.
-
-		#### Params:
-		- text (str): Text to remove format.
-
-		#### Returns:
-		- (str): Text without format.
-		"""
-		for formatting_char in self.__FORMATTING_CHARACTERS:
-			text = text.replace(formatting_char, "")
-		return text
-
-	def __get_n_last_lines(self) -> int:
-		"""
-		### This function returns the number of lines of the terminal the last print occupied.
-
-		#### Returns:
-		- (int): Number of lines of the last print. 
-		"""
-		return math.ceil(self.__len_last_printed_elem / shutil.get_terminal_size().columns)
-	
-	def __format_text(self, text: str, format_code: str) -> str:
-		"""
-		### Returns the given text formatted in the given format code.
-
-		#### Params:
-		- text (str): Text to format.
-		- format_code (str): Formatting character.
-
-		#### Returns:
-		- (str): Text formatted.
-		"""
-		return f"{format_code}{text}{self.__END_FORMAT}"
-
-	def __substitute_lines(self, text: str) -> str:
-		"""
-		### Removes the appropiate lines from the terminal to show a given text.
-
-		#### Params:
-		- text (str): Text to show substituting some lines.
-
-		#### Returns:
-		- (str): Text with line substitution characters as a prefix.
-		"""
-		substitution_chars = [f'{self.__UP}{self.__REMOVE_LINE}' for _ in range(self.__get_n_last_lines())]
-		return f"{''.join(substitution_chars)}{text}"
-	
+  def __init__(self):
+    """
+    ### Constructor.
+    
+    #### Params:
+    - ouputToConsoloe (bool): Print messages to console.
+    """
+    self.__log_file = None
+    self.__last_printed_elem = None
+    self.__allow_substitution = True
+  
+  def green(self, text: str) -> str:
+    """
+    ### This function returns the given text formatted in green color.
+
+    #### Params:
+    - text (str): Text to format.
+
+    #### Returns:
+    - (str): Text formatted in green color.
+    """
+    return self.__format_text(text, self.__GREEN)
+
+  def yellow(self, text: str) -> str:
+    """
+    ### This function returns the given text formatted in yellow color.
+
+    #### Params:
+    - text (str): Text to format.
+
+    #### Returns:
+    - (str): Text formatted in yellow color.
+    """
+    return self.__format_text(text, self.__YELLOW)
+
+  def red(self, text: str) -> str:
+    """
+    ### This function returns the given text formatted in red color.
+
+    #### Params:
+    - text (str): Text to format.
+
+    #### Returns:
+    - (str): Text formatted in red color.
+    """
+    return self.__format_text(text, self.__RED)
+
+  def blue(self, text: str) -> str:
+    """
+    ### This function returns the given text formatted in blue color.
+
+    #### Params:
+    - text (str): Text to format.
+
+    #### Returns:
+    - (str): Text formatted in blue color.
+    """
+    return self.__format_text(text, self.__BLUE)
+
+  def bold(self, text: str) -> str:
+    """
+    ### This function returns the given text formatted in bold.
+
+    #### Params:
+    - text (str): Text to format.
+
+    #### Returns:
+    - (str): Text formatted in bold.
+    """
+    return self.__format_text(text, self.__BOLD)
+
+  def start_log_file(self, log_path: str):
+    """
+    ### Initiates the log file.
+
+    #### Params:
+    - log_path (str): Path to the log file.
+    """
+    if self.__log_file is None:
+      self.__log_file = open(log_path, 'w', encoding="utf-8")
+
+  def close(self):
+    """### Closes the log file."""
+    if self.__log_file:
+      self.__log_file.close()
+      self.__log_file = None
+
+  def set_allow_substitution(self, allow_substitution: bool):
+    """
+    ### Modifies console output behaviour, allowing or disallowing substitutions.
+    
+    #### Params:
+    - allow_substitution (bool): If False, console outputs won't be substituted.
+    """
+    self.__allow_substitution = allow_substitution
+
+  def __call__(self, text: str, show_in_terminal: bool=True, substitute: bool=False):
+    """
+    ### Log a message.
+    
+    #### Params:
+    - text (str): Message to be logged. Supports fancy formatting.
+    - show_in_terminal (bool): Optional. If True, text is also printed through terminal.
+    - substitute (bool): Optional. If True, previous line is substituted with new text. Only used when show_in_terminal = True.
+    """
+    if self.__log_file is not None:
+      print(self.__remove_non_printable(text), file=self.__log_file, flush=True)
+      
+    if show_in_terminal:
+      text = self.__substitute_lines(text) if self.__allow_substitution and substitute else text
+      print(text, flush=True)
+    
+    # Store printed string for next substitution calculation
+    self.__last_printed_elem = self.__remove_non_printable(text) if self.__allow_substitution and substitute else None
+   
+  def log_error(self, error_msg: str, ret_code: int=1, add_portal_link: bool=True):
+    """
+    ### Prints an error message.
+
+    #### Params:
+    - error_msg (str): Error message to show.
+    - ret_code (int): Optional. Return code to end the exection with.
+    - add_portal_link (bool): If True, a message linking the documentation portal is shown.
+    """
+    error = errors.ERROR_CODES.get(ret_code, errors.ERROR_CODES[errors.UNKOW_ERROR])
+    error_str = error_msg + '\n\n' if error_msg else ''
+    error_str += f'Error {ret_code}: {error[0]}'
+    error_str += f"\n{error[1]}" if error[1] else ''
+    if add_portal_link:
+      error_str += f'\nMore details on the Xmipp documentation portal: {urls.DOCUMENTATION_URL}'
+
+    self.__call__(self.red(error_str), show_in_terminal=True)
+
+  def log_in_streaming(self, stream: BufferedReader, show_in_terminal: bool=False, substitute: bool=False, err: bool=False):
+    """
+    ### Receives a process output stream and logs its lines.
+
+    #### Params:
+    - stream (BufferedReader): Function to run.
+    - show_in_terminal (bool): Optional. If True, output will also be printed through terminal.
+    - substitute (bool): Optional. If True, output will replace previous line. Only used when show is True.
+    - err (bool): Optional. If True, the stream contains an error. Otherwise, it is regular output.
+    """
+    for line in iter(stream.readline, b''):
+      calling_line = line.decode().replace("\n", "")
+      if err:
+        calling_line = self.red(calling_line)
+      self.__call__(calling_line, show_in_terminal=show_in_terminal, substitute=substitute)
+
+  def __remove_non_printable(self, text: str) -> str:
+    """
+    ### This function returns the given text without non printable characters.
+
+    #### Params:
+    - text (str): Text to remove format.
+
+    #### Returns:
+    - (str): Text without format.
+    """
+    for formatting_char in self.__FORMATTING_CHARACTERS:
+      text = text.replace(formatting_char, "")
+    return text
+
+  def __get_n_last_lines(self) -> int:
+    """
+    ### This function returns the number of lines of the terminal the last print occupied.
+
+    #### Returns:
+    - (int): Number of lines of the last print. 
+    """
+    if self.__last_printed_elem is None:
+      return 0
+    
+    terminal_width = shutil.get_terminal_size().columns
+    # At least one line break exists, as prints end with line break
+    n_line_breaks = self.__last_printed_elem.count("\n") + 1
+    text_lines = self.__last_printed_elem.split("\n")
+    for line in text_lines:
+      n_line_breaks += int(len(line) / (terminal_width + 1)) # Equal does not count, it needs to exceed
+    return n_line_breaks
+  
+  def __format_text(self, text: str, format_code: str) -> str:
+    """
+    ### Returns the given text formatted in the given format code.
+
+    #### Params:
+    - text (str): Text to format.
+    - format_code (str): Formatting character.
+
+    #### Returns:
+    - (str): Text formatted.
+    """
+    return f"{format_code}{text}{self.__END_FORMAT}"
+
+  def __substitute_lines(self, text: str) -> str:
+    """
+    ### Removes the appropiate lines from the terminal to show a given text.
+
+    #### Params:
+    - text (str): Text to show substituting some lines.
+
+    #### Returns:
+    - (str): Text with line substitution characters as a prefix.
+    """
+    substitution_chars = [f'{self.__UP}{self.__REMOVE_LINE}' for _ in range(self.__get_n_last_lines())]
+    return f"{''.join(substitution_chars)}{text}"
+  
 """
 ### Global logger.
 """

xmipp3_installer/application/logger/predefined_messages.py

@@ -1,3 +1,9 @@
+"""
+### Predefined Messages Module.
+
+This module contains functions to generate standard log messages.
+"""
+
 from xmipp3_installer.application.logger.logger import logger
 from xmipp3_installer.installer.handlers import git_handler
 
@@ -22,45 +28,46 @@ def get_working_message() -> str:
   return logger.yellow("Working...")
 
 def get_section_message(text: str) -> str:
-	"""
-	### Returns the given text as a section header.
+  """
+  ### Returns the given text as a section header.
 
-	#### Params:
-	- text (str): Title of the section.
+  #### Params:
+  - text (str): Title of the section.
 
-	#### Returns:
-	- (str): Formatted section header.
-	"""
-	text_len = len(text)
-	remaining_len = __SECTION_MESSAGE_LEN - text_len
-	if remaining_len < 4:
-		return text
-	
-	n_dashes = remaining_len - 2
-	n_final_dashes = int(n_dashes / 2)
-	n_initial_dashes = n_dashes - n_final_dashes
-	final_dashes = ''.join(['-' for _ in range(n_final_dashes)])
-	initial_dashes = ''.join(['-' for _ in range(n_initial_dashes)])
-	return f"{initial_dashes} {text} {final_dashes}"
+  #### Returns:
+  - (str): Formatted section header.
+  """
+  minimum_remaining_len = len("-  -")
+  text_len = len(text)
+  remaining_len = __SECTION_MESSAGE_LEN - text_len
+  if remaining_len < minimum_remaining_len:
+    return text
+  
+  n_dashes = remaining_len - 2
+  n_final_dashes = int(n_dashes / 2)
+  n_initial_dashes = n_dashes - n_final_dashes
+  final_dashes = ''.join(['-' for _ in range(n_final_dashes)])
+  initial_dashes = ''.join(['-' for _ in range(n_initial_dashes)])
+  return f"{initial_dashes} {text} {final_dashes}"
 
 def get_success_message(tag_version: str) -> str:
-	"""
-	### Returns the message shown when Xmipp is compiled successfully.
+  """
+  ### Returns the message shown when Xmipp is compiled successfully.
 
-	#### Params:
-	- tag_version (str): Version number of the latest release.
-	
-	#### Returms:
-	- (str): Success message.
-	"""
-	release_name = tag_version if git_handler.is_tag() else git_handler.get_current_branch()
+  #### Params:
+  - tag_version (str): Version number of the latest release.
+  
+  #### Returms:
+  - (str): Success message.
+  """
+  release_name = tag_version if git_handler.is_tag() else git_handler.get_current_branch()
 
-	box_wrapper = '*  *'
-	half_len_box_wrapper = int(len(box_wrapper) / 2)
-	release_message = f'Xmipp {release_name} has been successfully installed, enjoy it!'
-	total_len = len(release_message) + len(box_wrapper)
-	release_message = f'{box_wrapper[:half_len_box_wrapper]}{logger.green(release_message)}{box_wrapper[half_len_box_wrapper:]}'
-	margin_line = f"*{' ' * (total_len - 2)}*"
-	box_border = '*' * total_len
+  box_wrapper = '*  *'
+  half_len_box_wrapper = int(len(box_wrapper) / 2)
+  release_message = f'Xmipp {release_name} has been successfully installed, enjoy it!'
+  total_len = len(release_message) + len(box_wrapper)
+  release_message = f'{box_wrapper[:half_len_box_wrapper]}{logger.green(release_message)}{box_wrapper[half_len_box_wrapper:]}'
+  margin_line = f"*{' ' * (total_len - 2)}*"
+  box_border = '*' * total_len
 
-	return '\n'.join(["", box_border, margin_line, release_message, margin_line, box_border])
+  return '\n'.join(["", box_border, margin_line, release_message, margin_line, box_border])

xmipp3_installer/application/user_interactions.py

@@ -1,3 +1,9 @@
+"""
+### User Interactions Module.
+
+This module contains functions to handle user interactions.
+"""
+
 def get_user_confirmation(confirmation_text: str, case_sensitive: bool=True) -> bool:
   """
   ### Receives confirmation from user input.

xmipp3_installer/installer/constants/paths.py

@@ -1,3 +1,9 @@
+"""
+### Paths Module.
+
+This module defines various paths used throughout the application.
+"""
+
 import os
 
 from xmipp3_installer.installer import constants
@@ -7,7 +13,6 @@ SOURCES_PATH = "src"
 BUILD_PATH = "build"
 INSTALL_PATH = "dist"
 BINARIES_PATH = os.path.join(INSTALL_PATH, "bin")
-#CMAKE_CACHE_PATH = os.path.join(BUILD_PATH, 'CMakeCache.txt')
 SCIPION_SOFTWARE_EM = os.path.join("scipionfiles", "downloads", "scipion", "software", "em")
 
 # General file paths