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

xmipp3_installer/installer/modes/mode_config_executor.py

@@ -1,3 +1,9 @@
+"""
+### Mode Config Executor Module.
+
+This module contains the class to manage the configuration file.
+"""
+
 import os
 from typing import Dict, Tuple
 
@@ -10,37 +16,42 @@ from xmipp3_installer.installer.modes import mode_executor
 from xmipp3_installer.repository import config
 
 class ModeConfigExecutor(mode_executor.ModeExecutor):
-	def __init__(self, context: Dict):
-		"""
-		### Constructor.
-		
-		#### Params:
-		- context (dict): Dictionary containing the installation context variables.
-		"""
-		super().__init__(context)
-		self.overwrite = context.pop(params.PARAM_OVERWRITE)
-		self.config_values = {}
-	
-	def run(self) -> Tuple[int, str]:
-		"""
-		### Reads the config file and writes to it formatting properly with the appropiate values.
+  """
+  ### Mode Config Executor.
+
+  Manages the configuration file for the installation.
+  """
+
+  def __init__(self, context: Dict):
+    """
+    ### Constructor.
+    
+    #### Params:
+    - context (dict): Dictionary containing the installation context variables.
+    """
+    super().__init__(context)
+    self.overwrite = context.pop(params.PARAM_OVERWRITE)
+    self.config_values = {}
+  
+  def run(self) -> Tuple[int, str]:
+    """
+    ### Reads the config file and writes to it formatting properly with the appropiate values.
 
-		#### Returns:
-		- (tuple(int, str)): Tuple containing the error status and an error message if there was an error. 
-		"""
-		logger(predefined_messages.get_section_message("Managing config file"))
-		action_message = (
-			"Generating config file from scratch with default values..."
-			if self.overwrite or not os.path.exists(paths.CONFIG_FILE) else
-			"Reading config file..."
-		)
-		logger(action_message)
-		try:
-			file_handler = config.ConfigurationFileHandler()
-			file_handler.write_config(overwrite=self.overwrite)
-		except PermissionError as permission_error:
-			return errors.IO_ERROR, str(permission_error)
-		self.config_values = file_handler.values
-		logger(predefined_messages.get_done_message())
-		return 0, ""
-	
+    #### Returns:
+    - (tuple(int, str)): Tuple containing the error status and an error message if there was an error. 
+    """
+    logger(predefined_messages.get_section_message("Managing config file"))
+    action_message = (
+      "Generating config file from scratch with default values..."
+      if self.overwrite or not os.path.exists(paths.CONFIG_FILE) else
+      "Reading config file..."
+    )
+    logger(action_message)
+    try:
+      file_handler = config.ConfigurationFileHandler()
+      file_handler.write_config(overwrite=self.overwrite)
+    except PermissionError as permission_error:
+      return errors.IO_ERROR, str(permission_error)
+    self.config_values = file_handler.values
+    logger(predefined_messages.get_done_message())
+    return 0, ""

xmipp3_installer/installer/modes/mode_executor.py

@@ -1,3 +1,9 @@
+"""
+### Mode Executor Module.
+
+This module contains the base executor interface for installer modes.
+"""
+
 from abc import ABC, abstractmethod
 from typing import Dict, Tuple
 
@@ -5,34 +11,29 @@ from xmipp3_installer.application.logger.logger import logger
 from xmipp3_installer.installer.constants import paths
 
 class ModeExecutor(ABC):
-  """
-  ### Base executor interface for installer modes.
-  """
+  """### Base executor interface for installer modes."""
+
   def __init__(self, context: Dict):
     """
-		### Constructor.
+    ### Constructor.
 		
-		#### Params:
-		- context (dict): Dictionary containing the installation context variables.
-		"""
+    #### Params:
+    - context (dict): Dictionary containing the installation context variables.
+    """
     super().__init__()
     self.context = context
     self._set_executor_config()
     self.__configure_logger()
   
   def _set_executor_config(self):
-    """
-    ### Sets the specific executor params for this mode.
-    """
+    """### Sets the specific executor params for this mode."""
     self.logs_to_file = False
     self.prints_with_substitution = False
     self.prints_banner_on_exit = False
     self.sends_installation_info = False
   
   def __configure_logger(self):
-    """
-    ### Configures the logger according to the specified config.
-    """
+    """### Configures the logger according to the specified config."""
     if self.logs_to_file:
       logger.start_log_file(paths.LOG_FILE)
     if self.prints_with_substitution:

xmipp3_installer/installer/modes/mode_get_sources_executor.py

@@ -1,3 +1,9 @@
+"""
+### Mode Get Sources Executor Module.
+
+This module contains the class to clone or update Xmipp source repositories.
+"""
+
 import os
 from typing import Dict, Tuple, Optional
 
@@ -10,123 +16,126 @@ from xmipp3_installer.installer.modes import mode_executor
 from xmipp3_installer.installer.handlers import git_handler, versions_manager, shell_handler
 
 class ModeGetSourcesExecutor(mode_executor.ModeExecutor):
-	def __init__(self, context: Dict):
-		"""
-		### Constructor.
-		
-		#### Params:
-		- context (dict): Dictionary containing the installation context variables.
-		- substitute (bool): Optional. If True, printed text will be substituted with the next message.
-		"""
-		super().__init__(context)
-		self.substitute = not context[params.PARAM_KEEP_OUTPUT]
-		self.target_branch = context.pop(params.PARAM_BRANCH)
-		versions: versions_manager.VersionsManager = context[constants.VERSIONS_CONTEXT_KEY]
-		self.xmipp_tag_name = versions.xmipp_version_name
-		self.source_versions: Dict = versions.sources_versions
-	
-	def run(self) -> Tuple[int, str]:
-		"""
-		### Executes the given git command into all xmipp source repositories.
+  """
+  ### Mode Get Sources Executor.
+
+  Clones or updates Xmipp source repositories.
+  """
+
+  def __init__(self, context: Dict):
+    """
+    ### Constructor.
+    
+    #### Params:
+    - context (dict): Dictionary containing the installation context variables.
+    - substitute (bool): Optional. If True, printed text will be substituted with the next message.
+    """
+    super().__init__(context)
+    self.substitute = not context[params.PARAM_KEEP_OUTPUT]
+    self.target_branch = context.pop(params.PARAM_BRANCH)
+    versions: versions_manager.VersionsManager = context[constants.VERSIONS_CONTEXT_KEY]
+    self.xmipp_tag_name = versions.xmipp_version_name
+    self.source_versions: Dict = versions.sources_versions
+  
+  def run(self) -> Tuple[int, str]:
+    """
+    ### Clones or updates Xmipp source repositories.
+
+    #### Returns:
+    - (tuple(int, str)): Tuple containing the return code and an error message if there was an error.
+    """
+    logger(predefined_messages.get_section_message("Getting Xmipp sources"))
+    for source in constants.XMIPP_SOURCES:
+      ret_code, output = self.__get_source(source)
+      if ret_code:
+        return errors.SOURCE_CLONE_ERROR, output
+    return 0, ""
+  
+  def _set_executor_config(self):
+    """### Sets the specific executor params for this mode."""
+    super()._set_executor_config()
+    self.prints_with_substitution = True
+  
+  def __select_ref_to_clone(self, source_name: str, source_repo: str) -> Optional[str]:
+    """
+    ### Selects the reference to clone from the source.
 
-		#### Returns:
-		- (tuple(int, str)): Tuple containing the return code and an error message if there was an error.
-		"""
-		logger(predefined_messages.get_section_message("Getting Xmipp sources"))
-		for source in constants.XMIPP_SOURCES:
-			ret_code, output = self.__get_source(source)
-			if ret_code:
-				return errors.SOURCE_CLONE_ERROR, output
-		return 0, ""
-	
-	def _set_executor_config(self):
-		"""
-		### Sets the specific executor params for this mode.
-		"""
-		super()._set_executor_config()
-		self.prints_with_substitution = True
-	
-	def __select_ref_to_clone(self, source_name: str, source_repo: str) -> str:
-		"""
-		### Selects the reference to clone from the source.
+    #### Params:
+    - source_name (str): Name of the source to clone.
+    - source_repo (str): URL of the source's repository.
 
-		#### Params:
-		- source_name (str): Name of the source to clone.
-		- source_repo (str): URL of the source's repository.
+    #### Returns:
+    - (str | None): The reference name to clone or None if no suitable ref was found.
+    """
+    current_branch = git_handler.get_current_branch()
+    tag_name = None
+    if (
+      not current_branch or
+      current_branch in {constants.MASTER_BRANCHNAME, self.xmipp_tag_name}
+    ):
+      tag_name = self.source_versions.get(source_name)
+    return git_handler.get_clonable_branch(source_repo, self.target_branch, tag_name)
+  
+  def __get_source(self, source_name: str) -> Tuple[int, str]:
+    """
+    ### Gets the given source.
+    
+    It is cloned if it does not already exist locally.
 
-		#### Returns:
-		- (str): The reference name to clone.
-		"""
-		current_branch = git_handler.get_current_branch()
-		tag_name = None
-		if (
-			not current_branch or
-			current_branch == constants.MASTER_BRANCHNAME or
-			current_branch == self.xmipp_tag_name
-		):
-			tag_name = self.source_versions.get(source_name)
-		return git_handler.get_clonable_branch(source_repo, self.target_branch, tag_name)
-	
-	def __run_source_command(self, source_name: str, source_repo: str, target_branch: Optional[str]) -> Tuple[int, str]:
-		"""
-		### Executes git clone/checkout commands for a source repository.
-		
-		If the source already exists locally:
-		- If target_branch is specified, checks out that branch.
-		- If no target_branch, returns success without changes.
-		
-		If the source doesn't exist:
-		- Clones the repository with the specified branch.
-		- If no branch specified, clones with default branch.
+    #### Params:
+    - source_name (str): Name of the source to clone.
 
-		#### Params:
-		- source_name (str): Name of the source repository.
-		- source_repo (str): URL of the git repository to clone from.
-		- target_branch (str | None): Branch or tag to checkout/clone.
+    #### Returns:
+    - (tuple(int, str)): Tuple containing the return code and the text output produced by the command.
+    """
+    repo_url = f"{urls.I2PC_REPOSITORY_URL}{source_name}"
+    logger(f"Cloning {source_name}...", substitute=self.substitute)
+    logger(predefined_messages.get_working_message(), substitute=self.substitute)
 
-		#### Returns:
-		- (tuple(int, str)): Tuple containing the return code and the text output produced by the command.
-		"""
-		source_path = paths.get_source_path(source_name)
-		if os.path.exists(source_path):
-			if not target_branch:
-				return 0, ""
-			return shell_handler.run_shell_command(
-				f"git checkout {target_branch}",
-				cwd=source_path
-			)
-		
-		branch_str = (
-			f"{params.PARAMS[params.PARAM_BRANCH][params.LONG_VERSION]} {target_branch}"
-			if target_branch else ""
-		)
-		return shell_handler.run_shell_command(f"git clone{branch_str} {source_repo}.git", cwd=paths.SOURCES_PATH)
-	
-	def __get_source(self, source_name: str) -> Tuple[int, str]:
-		"""
-		### Gets the given source.
-		
-		It is cloned if it does not already exist locally.
+    clone_branch = self.__select_ref_to_clone(source_name, repo_url)
+    if self.target_branch and not clone_branch:
+      warning_message = "\n".join([
+        logger.yellow(f"Warning: branch \'{self.target_branch}\' does not exist for repository with url {repo_url}"),
+        logger.yellow("Falling back to repository's default branch.")
+      ])
+      logger(warning_message, substitute=self.substitute)
+    
+    ret_code, output = _run_source_command(source_name, repo_url, clone_branch)
+    if not ret_code:
+      logger(predefined_messages.get_done_message(), substitute=self.substitute)
+    return ret_code, output
 
-		#### Params:
-		- source_name (str): Name of the source to clone.
+def _run_source_command(source_name: str, source_repo: str, target_branch: Optional[str]) -> Tuple[int, str]:
+  """
+  ### Executes git clone/checkout commands for a source repository.
+  
+  If the source already exists locally:
+  - If target_branch is specified, checks out that branch.
+  - If no target_branch, returns success without changes.
+  
+  If the source doesn't exist:
+  - Clones the repository with the specified branch.
+  - If no branch specified, clones with default branch.
 
-		#### Returns:
-		- (tuple(int, str)): Tuple containing the return code and the text output produced by the command.
-		"""
-		repo_url = f"{urls.I2PC_REPOSITORY_URL}{source_name}"
-		logger(f"Cloning {source_name}...", substitute=self.substitute)
-		logger(predefined_messages.get_working_message(), substitute=self.substitute)
+  #### Params:
+  - source_name (str): Name of the source repository.
+  - source_repo (str): URL of the git repository to clone from.
+  - target_branch (str | None): Branch or tag to checkout/clone.
 
-		clone_branch = self.__select_ref_to_clone(source_name, repo_url)
-		if self.target_branch and not clone_branch:
-			warning_message = logger.yellow("\n".join([
-				f"Warning: branch \'{self.target_branch}\' does not exist for repository with url {repo_url}.",
-				"Falling back to repository's default branch."
-			]))
-			logger(warning_message, substitute=self.substitute)
-		
-		ret_code, output = self.__run_source_command(source_name, repo_url, clone_branch)
-		if not ret_code:
-			logger(predefined_messages.get_done_message(), substitute=self.substitute)
-		return ret_code, output
+  #### Returns:
+  - (tuple(int, str)): Tuple containing the return code and the text output produced by the command.
+  """
+  source_path = paths.get_source_path(source_name)
+  if os.path.exists(source_path):
+    if not target_branch:
+      return 0, ""
+    return shell_handler.run_shell_command(
+      f"git checkout {target_branch}",
+      cwd=source_path
+    )
+  
+  branch_str = (
+    f"{params.PARAMS[params.PARAM_BRANCH][params.LONG_VERSION]} {target_branch}"
+    if target_branch else ""
+  )
+  return shell_handler.run_shell_command(f"git clone{branch_str} {source_repo}.git", cwd=paths.SOURCES_PATH)

xmipp3_installer/installer/modes/mode_git_executor.py

@@ -1,3 +1,9 @@
+"""
+### Mode Git Executor Module.
+
+This module contains the class to execute git commands on all Xmipp source repositories.
+"""
+
 from typing import Dict, Tuple
 
 from xmipp3_installer.application.cli.arguments import params
@@ -8,34 +14,40 @@ from xmipp3_installer.installer.modes import mode_executor
 from xmipp3_installer.installer.handlers import git_handler
 
 class ModeGitExecutor(mode_executor.ModeExecutor):
-	def __init__(self, context: Dict):
-		"""
-		### Constructor.
-		
-		#### Params:
-		- context (dict): Dictionary containing the installation context variables.
-		"""
-		super().__init__(context)
-		command_param_list = context.pop(params.PARAM_GIT_COMMAND)
-		self.command = ' '.join(command_param_list)
-	
-	def run(self) -> Tuple[int, str]:
-		"""
-		### Executes the given git command into all xmipp source repositories.
-
-		#### Returns:
-		- (tuple(int, str)): Tuple containing the return code and an error message if there was an error.
-		"""
-		logger(f"Running command 'git {self.command}' for all xmipp sources...")
-
-		for source in [constants.XMIPP, *constants.XMIPP_SOURCES]:
-			logger("\n" + logger.blue(
-				f"Running command for {source} in path {paths.get_source_path(source)}..."
-			))
-			ret_code, output = git_handler.execute_git_command_for_source(
-				self.command, source
-			)
-			if ret_code:
-				return ret_code, output
-
-		return 0, ""
+  """
+  ### Mode Git Executor.
+
+  Executes git commands on all Xmipp source repositories.
+  """
+
+  def __init__(self, context: Dict):
+    """
+    ### Constructor.
+    
+    #### Params:
+    - context (dict): Dictionary containing the installation context variables.
+    """
+    super().__init__(context)
+    command_param_list = context.pop(params.PARAM_GIT_COMMAND)
+    self.command = ' '.join(command_param_list)
+  
+  def run(self) -> Tuple[int, str]:
+    """
+    ### Executes the given git command into all xmipp source repositories.
+
+    #### Returns:
+    - (tuple(int, str)): Tuple containing the return code and an error message if there was an error.
+    """
+    logger(f"Running command 'git {self.command}' for all xmipp sources...")
+
+    for source in [constants.XMIPP, *constants.XMIPP_SOURCES]:
+      logger("\n" + logger.blue(
+        f"Running command for {source} in path {paths.get_source_path(source)}..."
+      ))
+      ret_code, output = git_handler.execute_git_command_for_source(
+        self.command, source
+      )
+      if ret_code:
+        return ret_code, output
+
+    return 0, ""

xmipp3_installer/installer/modes/mode_selector.py

@@ -1,3 +1,9 @@
+"""
+### Mode Selector Module.
+
+This module maps command-line modes to their corresponding executor classes.
+"""
+
 from xmipp3_installer.application.cli.arguments import modes
 from xmipp3_installer.installer.modes import (
   mode_config_executor, mode_version_executor, mode_git_executor,