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

xmipp3_installer/installer/modes/mode_clean/mode_clean_bin_executor.py

@@ -1,3 +1,10 @@
+"""
+### Mode Clean Bin Executor Module.
+
+This module contains the class to clean compiled binaries and related files.
+"""
+
+import fnmatch
 import glob
 import os
 import pathlib
@@ -9,86 +16,89 @@ from xmipp3_installer.installer.constants import paths
 from xmipp3_installer.installer.modes.mode_clean import mode_clean_executor
 
 class ModeCleanBinExecutor(mode_clean_executor.ModeCleanExecutor):
-	def _get_paths_to_delete(self) -> List[str]:
-		"""
-		### Returns a list of all the paths to be deleted.
+  """
+  ### Mode Clean Bin Executor.
 
-		#### Returns:
-		- (list(str)): List containing all the paths to delete.
-		"""
-		dblite_files = glob.glob(
-			"**/*.dblite",
-			recursive=True
-		)
-		return [
-			*dblite_files,
-			*ModeCleanBinExecutor.__get_compilation_files(),
-			*ModeCleanBinExecutor.__get_empty_dirs(),
-			*ModeCleanBinExecutor.__get_pycache_dirs(),
-			paths.BUILD_PATH
-		]
+  Cleans compiled binaries and related files.
+  """
 
-	def _get_confirmation_keyword(self) -> str:
-		"""
-		### Returns the keyword needed to be introduced by the user to confirm an operation.
+  @property
+  def confirmation_keyword(self) -> str:
+    """### Property containineg the keyword to confirm the cleaning operation."""
+    return "y"
+  
+  @staticmethod
+  def _get_paths_to_delete() -> List[str]:
+    """
+    ### Returns a list of all the paths to be deleted.
 
-		#### Returns:
-		- (str): Confirmation keyword.
-		"""
-		return "y"
-	
-	def _get_confirmation_message(self) -> str:
-		"""
-		### Returns message to be printed when asking for user confirmation.
+    #### Returns:
+    - (list(str)): List containing all the paths to delete.
+    """
+    dblite_files = glob.glob(
+      "**/*.dblite",
+      recursive=True
+    )
+    return [
+      *dblite_files,
+      *ModeCleanBinExecutor.__get_compilation_files(),
+      *ModeCleanBinExecutor.__get_empty_dirs(),
+      *ModeCleanBinExecutor.__get_pycache_dirs(),
+      paths.BUILD_PATH,
+      paths.BINARIES_PATH
+    ]
+  
+  def _get_confirmation_message(self) -> str:
+    """
+    ### Returns message to be printed when asking for user confirmation.
 
-		#### Returns:
-		- (str): Confirmation message.
-		"""
-		return '\n'.join([
-			logger.yellow(f"WARNING: This will DELETE from {paths.SOURCES_PATH} all *.so, *.os and *.o files. Also the *.pyc and *.dblite files"),
-			logger.yellow(f"If you are sure you want to do this, type '{self._get_confirmation_keyword()}' (case sensitive):")
-		])
-	
-	@staticmethod
-	def __get_compilation_files():
-		"""
-		### Returns a list of all the compilation-related files.
+    #### Returns:
+    - (str): Confirmation message.
+    """
+    return '\n'.join([
+      logger.yellow(f"WARNING: This will DELETE from {paths.SOURCES_PATH} all *.so, *.os and *.o files. Also the *.pyc and *.dblite files"),
+      logger.yellow(f"If you are sure you want to do this, type '{self.confirmation_keyword}' (case sensitive):")
+    ])
+  
+  @staticmethod
+  def __get_compilation_files():
+    """
+    ### Returns a list of all the compilation-related files.
 
-		#### Returns:
-		- (list(str)): List containing all the paths to compilation-related files.
-		"""
-		compilation_files = []
-		for root, _, files in os.walk(paths.SOURCES_PATH):
-			for pattern in ['*.so', '*.os', '*.o']:
-				for filename in glob.fnmatch.filter(files, pattern):
-					compilation_files.append(os.path.join(root, filename))
-		return compilation_files
+    #### Returns:
+    - (list(str)): List containing all the paths to compilation-related files.
+    """
+    compilation_files = []
+    for root, _, files in os.walk(paths.SOURCES_PATH):
+      for pattern in ['*.so', '*.os', '*.o']:
+        for filename in fnmatch.filter(files, pattern):
+          compilation_files.append(os.path.join(root, filename))
+    return compilation_files
 
-	@staticmethod
-	def __get_empty_dirs() -> List[str]:
-		"""
-		### Returns a list with all the empty directories inside the programs folder.
+  @staticmethod
+  def __get_empty_dirs() -> List[str]:
+    """
+    ### Returns a list with all the empty directories inside the programs folder.
 
-		#### Returns:
-		- (list(str)): List containing the paths to all the empty directories.
-		"""
-		empty_dirs = [] 
-		for root, dirs, files in os.walk(os.path.join(
-			paths.SOURCES_PATH, constants.XMIPP, "applications", "programs"
-		)): 
-			if not len(dirs) and not len(files): 
-				empty_dirs.append(root) 
-		return empty_dirs
+    #### Returns:
+    - (list(str)): List containing the paths to all the empty directories.
+    """
+    empty_dirs = [] 
+    for root, dirs, files in os.walk(os.path.join(
+      paths.SOURCES_PATH, constants.XMIPP, "applications", "programs"
+    )): 
+      if not len(dirs) and not len(files): 
+        empty_dirs.append(root) 
+    return empty_dirs
 
-	@staticmethod
-	def __get_pycache_dirs() -> List[str]:
-		"""
-		### Returns a list of all the __pycache__ directories.
+  @staticmethod
+  def __get_pycache_dirs() -> List[str]:
+    """
+    ### Returns a list of all the __pycache__ directories.
 
-		#### Returns:
-		- (list(str)): List containing all the paths to __pycache__ directories.
-		"""
-		return [
-			str(path) for path in pathlib.Path().rglob('__pycache__')
-		]
-	
+    #### Returns:
+    - (list(str)): List containing all the paths to __pycache__ directories.
+    """
+    return [
+      str(path) for path in pathlib.Path().rglob('__pycache__')
+    ]

xmipp3_installer/installer/modes/mode_clean/mode_clean_executor.py

@@ -1,3 +1,9 @@
+"""
+### Mode Clean Executor Module.
+
+This module contains the base class for executors that clean compiled binaries.
+"""
+
 from abc import abstractmethod
 from typing import Tuple, List
 
@@ -9,37 +15,45 @@ from xmipp3_installer.installer.modes import mode_executor
 from xmipp3_installer.shared import file_operations
 
 class ModeCleanExecutor(mode_executor.ModeExecutor):
-	def run(self) -> Tuple[int, str]:
-		"""
-		### Deletes the compiled binaries.
-
-		#### Returns:
-		- (tuple(int, str)): Tuple containing the error status and an error message if there was an error. 
-		"""
-		if not self.__get_confirmation():
-			return errors.INTERRUPTED_ERROR, ""
-		file_operations.delete_paths(self._get_paths_to_delete())
-		logger(predefined_messages.get_done_message())
-		return 0, ""
-	
-	def __get_confirmation(self) -> bool:
-		"""
-		### Asks the user for confirmation.
-
-		#### Returns:
-		- (bool): True if the user confirms, False otherwise.
-		"""
-		logger(self._get_confirmation_message())
-		return user_interactions.get_user_confirmation(self._get_confirmation_keyword())
-	
-	@abstractmethod
-	def _get_paths_to_delete(self) -> List[str]:
-		"""Get paths to delete method to be implemented by the inheriting classes."""
-	
-	@abstractmethod
-	def _get_confirmation_message(self) -> str:
-		"""Get confirmation message method to be implemented by the inheriting classes."""
-	
-	@abstractmethod
-	def _get_confirmation_keyword(self) -> str:
-		"""Get confirmation keyword method to be implemented by the inheriting classes."""
+  """
+  ### Mode Clean Executor.
+
+  Base class for executors that clean compiled binaries.
+  """
+  
+  def run(self) -> Tuple[int, str]:
+    """
+    ### Deletes the compiled binaries.
+
+    #### Returns:
+    - (tuple(int, str)): Tuple containing the error status and an error message if there was an error. 
+    """
+    if not self.__get_confirmation():
+      return errors.INTERRUPTED_ERROR, ""
+    file_operations.delete_paths(self.__class__._get_paths_to_delete())
+    logger(predefined_messages.get_done_message())
+    return 0, ""
+  
+  def __get_confirmation(self) -> bool:
+    """
+    ### Asks the user for confirmation.
+
+    #### Returns:
+    - (bool): True if the user confirms, False otherwise.
+    """
+    logger(self._get_confirmation_message())
+    return user_interactions.get_user_confirmation(self.confirmation_keyword)
+  
+  @property
+  @abstractmethod
+  def confirmation_keyword(self) -> str:
+    """### Confirmation keyword propery to be defined by inheriting classes."""
+
+  @staticmethod
+  @abstractmethod
+  def _get_paths_to_delete() -> List[str]:
+    """Get paths to delete method to be implemented by the inheriting classes."""
+  
+  @abstractmethod
+  def _get_confirmation_message(self) -> str:
+    """Get confirmation message method to be implemented by the inheriting classes."""

xmipp3_installer/installer/modes/mode_cmake/mode_cmake_executor.py

@@ -1,55 +1,68 @@
-import shutil
+"""
+### Mode CMake Executor Module.
+
+This module contains the base class for executors that run CMake commands.
+"""
+
 from abc import abstractmethod
-from typing import Dict, Tuple, Optional
+from typing import Dict, Optional, Tuple
 
 from xmipp3_installer.application.cli.arguments import params
 from xmipp3_installer.application.logger import errors
+from xmipp3_installer.installer.handlers.cmake import cmake_handler
 from xmipp3_installer.installer.modes import mode_executor
 from xmipp3_installer.repository.config_vars import variables
 
 class ModeCMakeExecutor(mode_executor.ModeExecutor):
-	def __init__(self, context: Dict):
-		"""
-		### Constructor.
-		
-		#### Params:
-		- context (dict): Dictionary containing the installation context variables.
-		"""
-		super().__init__(context)
-		self.substitute = not context[params.PARAM_KEEP_OUTPUT]
-		self.cmake = context[variables.CMAKE]
-		self.build_type = context[variables.BUILD_TYPE]
-
-	def run(self) -> Tuple[int, str]:
-		"""
-		### Runs the CMake config with the appropiate params.
-
-		#### Returns:
-		- (tuple(int, str)): Tuple containing the error status and an error message if there was an error. 
-		"""
-		cmake = self.__get_cmake_executable()
-		if not cmake:
-			return errors.CMAKE_ERROR, "CMake installation not found."
-		return self._run_cmake_mode(cmake)
-	
-	def _set_executor_config(self):
-		"""
-		### Sets the specific executor params for this mode.
-		"""
-		super()._set_executor_config()
-		self.logs_to_file = True
-		self.prints_with_substitution = True
-	
-	def __get_cmake_executable(self) -> Optional[str]:
-		"""
-		### Returns the path to the CMake executable to be used.
-
-		#### Returns:
-		- (str | None): Path to the CMake executable. None if it was not found.
-		"""
-		return self.cmake or shutil.which("cmake")
-	
-	@abstractmethod
-	def _run_cmake_mode(self, cmake: str) -> Tuple[int, str]:
-		"""Run CMake mode method to be implemented by inheriting classes."""
-	
+  """
+  ### Mode CMake Executor.
+
+  Base class for executors that run CMake commands.
+  """
+
+  def __init__(self, context: Dict):
+    """
+    ### Constructor.
+    
+    #### Params:
+    - context (dict): Dictionary containing the installation context variables.
+    """
+    super().__init__(context)
+    self.substitute = not context[params.PARAM_KEEP_OUTPUT]
+    self.cmake = context[variables.CMAKE]
+    self.build_type = context[variables.BUILD_TYPE]
+
+  def run(self) -> Tuple[int, str]:
+    """
+    ### Runs the CMake config with the appropiate params.
+
+    #### Returns:
+    - (tuple(int, str)): Tuple containing the error status and an error message if there was an error. 
+    """
+    cmake = self.__get_cmake_executable()
+    if not cmake:
+      return errors.CMAKE_ERROR, "CMake installation not found."
+    return self._run_cmake_mode(cmake)
+  
+  def _set_executor_config(self):
+    """### Sets the specific executor params for this mode."""
+    super()._set_executor_config()
+    self.logs_to_file = True
+    self.prints_with_substitution = True
+  
+  def __get_cmake_executable(self) -> Optional[str]:
+    """
+    ### Returns the path to the CMake executable to be used.
+
+    #### Returns:
+    - (str | None): Path to the CMake executable. None if it was not found.
+    """
+    return self.cmake or cmake_handler.get_cmake_path()
+  
+  @staticmethod
+  def _get_error_code(ret_code, mode_error_code):
+    return ret_code if ret_code == errors.INTERRUPTED_ERROR else mode_error_code
+  
+  @abstractmethod
+  def _run_cmake_mode(self, cmake: str) -> Tuple[int, str]:
+    """Run CMake mode method to be implemented by inheriting classes."""

xmipp3_installer/installer/modes/mode_cmake/mode_compile_and_install_executor.py

@@ -1,3 +1,9 @@
+"""
+### Mode Compile And Install Executor Module.
+
+This module contains the class to compile and install using CMake.
+"""
+
 from typing import Tuple, Dict
 
 from xmipp3_installer.application.cli.arguments import params
@@ -8,42 +14,49 @@ from xmipp3_installer.installer.handlers import shell_handler
 from xmipp3_installer.installer.modes.mode_cmake import mode_cmake_executor
 
 class ModeCompileAndInstallExecutor(mode_cmake_executor.ModeCMakeExecutor):
-	def __init__(self, context: Dict):
-		"""
-		### Constructor.
-		
-		#### Params:
-		- context (dict): Dictionary containing the installation context variables.
-		"""
-		super().__init__(context)
-		self.jobs = context[params.PARAM_JOBS]
-
-	def _set_executor_config(self):
-		"""
-		### Sets the specific executor params for this mode.
-		"""
-		super()._set_executor_config()
-		self.prints_banner_on_exit = True
-
-	def _run_cmake_mode(self, cmake: str) -> Tuple[int, str]:
-		"""
-		### Runs the CMake compilation & installation with the appropiate params.
-
-		#### Params:
-		- cmake (str): Path to CMake executable.
-
-		#### Returns:
-		- (tuple(int, str)): Tuple containing the error status and an error message if there was an error. 
-		"""
-		logger(predefined_messages.get_section_message("Compiling with CMake"))
-		cmd = f"{cmake} --build {paths.BUILD_PATH} --config {self.build_type} -j {self.jobs}"
-		if shell_handler.run_shell_command_in_streaming(cmd, show_output=True, substitute=self.substitute):
-			return errors.CMAKE_COMPILE_ERROR, ""
-		
-		installation_section_message = predefined_messages.get_section_message("Installing with CMake")
-		logger(f"\n{installation_section_message}")
-		cmd = f"{cmake} --install {paths.BUILD_PATH} --config {self.build_type}"
-		if shell_handler.run_shell_command_in_streaming(cmd, show_output=True, substitute=self.substitute):
-			return errors.CMAKE_INSTALL_ERROR, ""
-		return 0, ""
-	
+  """
+  ### Mode Compile And Install Executor.
+
+  Compiles and installs using CMake with the appropriate parameters.
+  """
+  
+  def __init__(self, context: Dict):
+    """
+    ### Constructor.
+    
+    #### Params:
+    - context (dict): Dictionary containing the installation context variables.
+    """
+    super().__init__(context)
+    self.jobs = context[params.PARAM_JOBS]
+
+  def _set_executor_config(self):
+    """### Sets the specific executor params for this mode."""
+    super()._set_executor_config()
+    self.prints_banner_on_exit = True
+
+  def _run_cmake_mode(self, cmake: str) -> Tuple[int, str]:
+    """
+    ### Runs the CMake compilation & installation with the appropiate params.
+
+    #### Params:
+    - cmake (str): Path to CMake executable.
+
+    #### Returns:
+    - (tuple(int, str)): Tuple containing the error status and an error message if there was an error. 
+    """
+    logger(predefined_messages.get_section_message("Compiling with CMake"))
+    cmd = f"{cmake} --build {paths.BUILD_PATH} --config {self.build_type} -j {self.jobs}"
+    ret_code = shell_handler.run_shell_command_in_streaming(cmd, show_output=True, substitute=self.substitute)
+    if ret_code:
+      return self._get_error_code(ret_code, errors.CMAKE_COMPILE_ERROR), ""
+    logger(predefined_messages.get_done_message(), substitute=self.substitute)
+    
+    installation_section_message = predefined_messages.get_section_message("Installing with CMake")
+    logger(f"\n{installation_section_message}")
+    cmd = f"{cmake} --install {paths.BUILD_PATH} --config {self.build_type}"
+    ret_code = shell_handler.run_shell_command_in_streaming(cmd, show_output=True, substitute=self.substitute)
+    if ret_code:
+      return self._get_error_code(ret_code, errors.CMAKE_INSTALL_ERROR), ""
+    logger(predefined_messages.get_done_message(), substitute=self.substitute)
+    return 0, ""

xmipp3_installer/installer/modes/mode_cmake/mode_config_build_executor.py

@@ -1,64 +1,83 @@
-from typing import Tuple, List, Optional, Union
+"""
+### Mode Config Build Executor Module.
 
-from xmipp3_installer.application.logger import predefined_messages, errors
+This module contains the class to configure the build using CMake.
+"""
+
+from typing import List, Optional, Tuple, Union, cast
+
+from xmipp3_installer.application.logger import errors, predefined_messages
 from xmipp3_installer.application.logger.logger import logger
 from xmipp3_installer.installer.constants import paths
 from xmipp3_installer.installer.handlers import shell_handler
+from xmipp3_installer.installer.handlers.cmake import cmake_handler
 from xmipp3_installer.installer.modes.mode_cmake import mode_cmake_executor
 from xmipp3_installer.repository.config_vars import variables
 
 class ModeConfigBuildExecutor(mode_cmake_executor.ModeCMakeExecutor):
-	def _run_cmake_mode(self, cmake: str) -> Tuple[int, str]:
-		"""
-		### Runs the CMake config with the appropiate params.
+  """
+  ### Mode Config Build Executor.
+
+  Configures the build using CMake with the appropriate parameters.
+  """
+  
+  def _run_cmake_mode(self, cmake: str) -> Tuple[int, str]:
+    """
+    ### Runs the CMake config with the appropiate params.
 
-		#### Params:
-		- cmake (str): Path to CMake executable.
+    #### Params:
+    - cmake (str): Path to CMake executable.
 
-		#### Returns:
-		- (tuple(int, str)): Tuple containing the error status and an error message if there was an error. 
-		"""
-		logger(predefined_messages.get_section_message("Configuring with CMake"))
-		cmd = f"{cmake} -S . -B {paths.BUILD_PATH} -DCMAKE_BUILD_TYPE={self.build_type} {self.__get_cmake_vars()}"
-		if shell_handler.run_shell_command_in_streaming(cmd, show_output=True, substitute=self.substitute):
-			return errors.CMAKE_CONFIGURE_ERROR, ""
-		return 0, ""
-	
-	def __get_cmake_vars(self) -> str:
-		"""
-		### Returns the CMake variables required for the configuration step.
+    #### Returns:
+    - (tuple(int, str)): Tuple containing the error status and an error message if there was an error. 
+    """
+    logger(predefined_messages.get_section_message("Configuring with CMake"))
+    cmd = f"{cmake} -S . -B {paths.BUILD_PATH} -DCMAKE_BUILD_TYPE={self.build_type} {self.__get_cmake_vars()}"
+    ret_code = shell_handler.run_shell_command_in_streaming(cmd, show_output=True, substitute=self.substitute)
+    if ret_code:
+      return self._get_error_code(ret_code, errors.CMAKE_CONFIGURE_ERROR), ""
+    logger(predefined_messages.get_done_message(), substitute=self.substitute)
+    return 0, ""
+  
+  def __get_cmake_vars(self) -> str:
+    """
+    ### Returns the CMake variables required for the configuration step.
 
-		#### Returns:
-		- (str): String containing all required CMake variables
-		"""
-		return " ".join([
-			f"-D{variable_key}={self.context[variable_key]}" for variable_key
-			in self.__get_config_vars() if not self.__is_empty(self.context[variable_key])
-		])
-	
-	def __get_config_vars(self) -> List[str]:
-		"""
-		### Returns all non-internal config variable keys.
+    #### Returns:
+    - (str): String containing all required CMake variables
+    """
+    non_empty_variables = [
+      (
+        variable_key,
+        cast(Union[str, bool], self.context[variable_key])
+      ) for variable_key in _get_non_internal_config_vars()
+      if not _is_empty(self.context[variable_key])
+    ]
+    return cmake_handler.get_cmake_params(non_empty_variables)
+  
+def _get_non_internal_config_vars() -> List[str]:
+  """
+  ### Returns all non-internal config variable keys.
 
-		#### Returns:
-		- (list(str)): A list containing all non-internal config variable keys.
-		"""
-		all_config_var_keys = [
-			config_var for variable_section in variables.CONFIG_VARIABLES.values()
-			for config_var in variable_section
-		]
-		non_internal_keys = list(set(all_config_var_keys) - set(variables.INTERNAL_LOGIC_VARS))
-		non_internal_keys.sort() # To keep order consistency
-		return non_internal_keys
+  #### Returns:
+  - (list(str)): A list containing all non-internal config variable keys.
+  """
+  all_config_var_keys = [
+    config_var for variable_section in variables.CONFIG_VARIABLES.values()
+    for config_var in variable_section
+  ]
+  non_internal_keys = list(set(all_config_var_keys) - set(variables.INTERNAL_LOGIC_VARS))
+  non_internal_keys.sort() # To keep order consistency
+  return non_internal_keys
 
-	def __is_empty(self, value: Optional[Union[bool, str]]) -> bool:
-		"""
-		### Checks if the given config value is empty.
+def _is_empty(value: Optional[Union[bool, str]]) -> bool:
+  """
+  ### Checks if the given config value is empty.
 
-		#### Params:
-		- value (bool | str | None): Value to be checked.
+  #### Params:
+  - value (bool | str | None): Value to be checked.
 
-		#### Returns:
-		- (bool): True if it is empty, False otherwise.
-		"""
-		return value is None or value == ""
+  #### Returns:
+  - (bool): True if it is empty, False otherwise.
+  """
+  return not isinstance(value, bool) and not value