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

xmipp3_installer/installer/handlers/cmake/cmake_handler.py

@@ -2,68 +2,64 @@
 
 import os
 import shutil
-from typing import Dict, Any
+from typing import Any, Dict, Optional, Tuple, Union, List
 
 from xmipp3_installer.installer.handlers.cmake import cmake_constants
-from xmipp3_installer.repository.config_vars import variables
 
-def get_cmake_path(config: Dict[str, Any]) -> str:
-	"""
-	### Retrieves information about the CMake package and updates the dictionary accordingly.
+def get_cmake_path() -> Optional[str]:
+  """
+  ### Returns the path to the CMake executable.
 
-	#### Params:
-	- packages (dict): Dictionary containing package information.
+  #### Returns:
+  - (str | None): Path to the CMake executable if found, None otherwise.
+  """
+  return shutil.which(cmake_constants.DEFAULT_CMAKE)
 
-	#### Returns:
-	- (dict): Param 'packages' with the 'CMAKE' key updated based on the availability of 'cmake'.
-	"""
-	return config.get(variables.CMAKE) or shutil.which(cmake_constants.DEFAULT_CMAKE)
+def get_cmake_params(variables: List[Tuple[str, Union[str, bool]]]) -> str:
+  """
+  ### Converts the given list of variable names into CMake parameters.
 
-def get_cmake_vars_str(config: Dict[str, Any]) -> str:
-	"""
-	### Converts the variables in the config dictionary into a list as CMake args.
-	
-	#### Params:
-	- config (dict): Dictionary to obtain the parameters from.
-	"""
-	result = []
-	for (key, value) in config.items():
-		if key not in variables.INTERNAL_LOGIC_VARS and bool(value):
-			result.append(f"-D{key}={value}")
-	return ' '.join(result)
+  #### Params:
+  - variables (list): List of variable names to obtain the parameters from.
+  """
+  result = []
+  for key, value in variables:
+    result.append(f"-D{key}={value}")
+  return ' '.join(result)
 
 def get_library_versions_from_cmake_file(path: str) -> Dict[str, Any]:
-	"""
-	### Obtains the library versions from the CMake cache file.
+  """
+  ### Obtains the library versions from the CMake cache file.
 
-	#### Params:
-	- path (str): Path to the file containing all versions.
+  #### Params:
+  - path (str): Path to the file containing all versions.
 
-	#### Returns:
-	- (dict(str, any)): Dictionary containing all the library versions in the file.
-	"""
-	if not os.path.exists(path):
-		return {}
-	
-	result = {}
-	with open(path, 'r') as versions_file:
-		for line in versions_file.readlines():
-			result.update(__get_library_version_from_line(line))
-	return result
+  #### Returns:
+  - (dict(str, any)): Dictionary containing all the library versions in the file.
+  """
+  if not os.path.exists(path):
+    return {}
+  
+  result = {}
+  with open(path, encoding="utf-8") as versions_file:
+    for line in versions_file.readlines():
+      result.update(__get_library_version_from_line(line))
+  return result
 
 def __get_library_version_from_line(version_line: str) -> Dict[str, Any]:
-	"""
-	### Retrieves the name and version of the library in the given line.
-	
-	#### Params:
-	- version_line (str): Text line containing the name and version of the library.
-	
-	#### Returns:
-	- (dict(str, any)): Dictionary where the key is the name and the value is the version.
-	"""
-	library_with_version = {}
-	name_and_version = version_line.replace("\n", "").split('=')
-	if len(name_and_version) == 2:
-		version = name_and_version[1] if name_and_version[1] else None
-		library_with_version[name_and_version[0]] = version
-	return library_with_version
+  """
+  ### Retrieves the name and version of the library in the given line.
+  
+  #### Params:
+  - version_line (str): Text line containing the name and version of the library.
+  
+  #### Returns:
+  - (dict(str, any)): Dictionary where the key is the name and the value is the version.
+  """
+  TOKEN_NUMBER = 2 # Two tokens separated by a =
+  library_with_version = {}
+  name_and_version = version_line.replace("\n", "").split('=')
+  if len(name_and_version) == TOKEN_NUMBER:
+    version = name_and_version[1] if name_and_version[1] else None
+    library_with_version[name_and_version[0]] = version
+  return library_with_version

xmipp3_installer/installer/handlers/conda_handler.py

@@ -4,10 +4,10 @@ import os
 from typing import Optional
 
 def get_conda_prefix_path() -> Optional[str]:
-	"""
-	### Returns the path for the current Conda enviroment.
+  """
+  ### Returns the path for the current Conda enviroment.
 
-	#### Returns:
-	- (str | None): Path for current Conda enviroment.
-	"""
-	return os.environ.get('CONDA_PREFIX')
+  #### Returns:
+  - (str | None): Path for current Conda enviroment.
+  """
+  return os.environ.get('CONDA_PREFIX')

xmipp3_installer/installer/handlers/generic_package_handler.py

@@ -5,14 +5,14 @@ from typing import Optional
 from xmipp3_installer.installer.handlers import shell_handler
 
 def get_package_version(package_name: str) -> Optional[str]:
-	"""
-	### Retrieves the version of a package or program by executing '[package_name] --version' command.
+  """
+  ### Retrieves the version of a package or program by executing '[package_name] --version' command.
 
-	Params:
-	- package_name (str): Name of the package or program.
+  Params:
+  - package_name (str): Name of the package or program.
 
-	Returns:
-	- (str | None): Version information of the package or None if not found or errors happened.
-	"""
-	ret_code, output = shell_handler.run_shell_command(f'{package_name} --version')
-	return output if ret_code == 0 else None
+  Returns:
+  - (str | None): Version information of the package or None if not found or errors happened.
+  """
+  ret_code, output = shell_handler.run_shell_command(f'{package_name} --version')
+  return output if ret_code == 0 else None

xmipp3_installer/installer/handlers/git_handler.py

@@ -8,178 +8,177 @@ from xmipp3_installer.installer.constants import paths
 from xmipp3_installer.installer.handlers import shell_handler
 
 def get_current_branch(dir: str='./') -> str:
-	"""
-	### Returns the current branch of the repository of the given directory or empty string if it is not a repository or a recognizable tag.
-	
-	#### Params:
-	- dir (str): Optional. Directory of the repository to get current branch from. Default is current directory.
-	
-	#### Returns:
-	- (str): The name of the branch, 'HEAD' if a tag, or empty string if given directory is not a repository or a recognizable tag.
-	"""
-	ret_code, branch_name = shell_handler.run_shell_command("git rev-parse --abbrev-ref HEAD", cwd=dir)
-	# If there was an error, we are in no branch
-	return branch_name if not ret_code else ''
+  """
+  ### Returns the current branch of the repository of the given directory or empty string if it is not a repository or a recognizable tag.
+  
+  #### Params:
+  - dir (str): Optional. Directory of the repository to get current branch from. Default is current directory.
+  
+  #### Returns:
+  - (str): The name of the branch, 'HEAD' if a tag, or empty string if given directory is not a repository or a recognizable tag.
+  """
+  ret_code, branch_name = shell_handler.run_shell_command("git rev-parse --abbrev-ref HEAD", cwd=dir)
+  # If there was an error, we are in no branch
+  return branch_name if not ret_code else ''
 
 def is_tag(dir: str='./') -> bool:
-	"""
-	### Returns True if the current Xmipp repository is in a tag.
-
-	#### Params:
-	- dir (str): Optional. Directory of the repository where the check will happen. Default is current directory.
-	
-	#### Returns:
-	- (bool): True if the repository is a tag. False otherwise.
-	"""
-	current_branch = get_current_branch(dir=dir)
-	return not current_branch or current_branch == "HEAD"
+  """
+  ### Returns True if the current Xmipp repository is in a tag.
+
+  #### Params:
+  - dir (str): Optional. Directory of the repository where the check will happen. Default is current directory.
+  
+  #### Returns:
+  - (bool): True if the repository is a tag. False otherwise.
+  """
+  current_branch = get_current_branch(dir=dir)
+  return not current_branch or current_branch == "HEAD"
 
 def is_branch_up_to_date(dir: str='./') -> bool:
-	"""
-	### Returns True if the current branch is up to date, or False otherwise or if some error happened.
-	
-	#### Params:
-	- dir (str): Optional. Directory of the repository to get current branch from. Default is current directory.
-	
-	#### Returns:
-	- (bool): True if the current branch is up to date, or False otherwise or if some error happened.
-	"""
-	current_branch = get_current_branch(dir=dir)
-	if not current_branch:
-		return False
-	
-	ret_code = shell_handler.run_shell_command("git fetch", cwd=dir)[0]
-	if ret_code != 0:
-		return False
-
-	latest_local_commit = shell_handler.run_shell_command(f"git rev-parse {current_branch}", cwd=dir)[1]
-	ret_code, latest_remote_commit = shell_handler.run_shell_command(f"git rev-parse origin/{current_branch}")
-	if ret_code != 0:
-		return False
-	
-	return latest_local_commit == latest_remote_commit
+  """
+  ### Returns True if the current branch is up to date, or False otherwise or if some error happened.
+  
+  #### Params:
+  - dir (str): Optional. Directory of the repository to get current branch from. Default is current directory.
+  
+  #### Returns:
+  - (bool): True if the current branch is up to date, or False otherwise or if some error happened.
+  """
+  current_branch = get_current_branch(dir=dir)
+  if not current_branch:
+    return False
+  
+  ret_code = shell_handler.run_shell_command("git fetch", cwd=dir)[0]
+  if ret_code != 0:
+    return False
+
+  latest_local_commit = shell_handler.run_shell_command(f"git rev-parse {current_branch}", cwd=dir)[1]
+  ret_code, latest_remote_commit = shell_handler.run_shell_command(f"git rev-parse origin/{current_branch}")
+  if ret_code != 0:
+    return False
+  
+  return latest_local_commit == latest_remote_commit
 
 def get_current_commit(dir: str="./") -> str:
-	"""
-	### Rreturns the current commit short hash of a given repository:
+  """
+  ### Returns the current commit short hash of a given repository.
 
-	#### Params:
-	- dir (str): Optional. Directory of repository.
+  #### Params:
+  - dir (str): Optional. Directory of repository.
 
-	#### Returns:
-	- (str): Current commit short hash, or empty string if it is not a repo or there were errors.
-	"""
-	ret_code, output = shell_handler.run_shell_command("git rev-parse --short HEAD", cwd=dir)
-	if ret_code or not output:
-		return ''
-	return output
+  #### Returns:
+  - (str): Current commit short hash, or empty string if it is not a repo or there were errors.
+  """
+  ret_code, output = shell_handler.run_shell_command("git rev-parse --short HEAD", cwd=dir)
+  if ret_code or not output:
+    return ''
+  return output
 
 def get_commit_branch(commit: str, dir: str="./") -> str:
-	"""
-	### Returns the name of the commit branch. It can be a branch name or a release name.
+  """
+  ### Returns the name of the commit branch. It can be a branch name or a release name.
 
-	#### Params:
-	- commit (str): Commit hash.
-	- dir (str): Optional. Directory to repository.
+  #### Params:
+  - commit (str): Commit hash.
+  - dir (str): Optional. Directory to repository.
 
-	#### Returns:
-	- (str): Name of the commit branch or release.
-	"""
-	ret_code, output = shell_handler.run_shell_command(f"git name-rev {commit}", cwd=dir)
-	if ret_code or not output:
-		return ''
-	return output.replace(commit, "").replace(" ", "")
+  #### Returns:
+  - (str): Name of the commit branch or release.
+  """
+  ret_code, output = shell_handler.run_shell_command(f"git name-rev {commit}", cwd=dir)
+  if ret_code or not output:
+    return ''
+  return output.replace(commit, "").replace(" ", "")
 
 def branch_exists_in_repo(repo_url: str, branch: str) -> bool:
-	"""
-	### Checks if the given branch exists in the given repository.
+  """
+  ### Checks if the given branch exists in the given repository.
 
-	#### Params:
-	- repo (str): Repository to check from.
-	- branch (str): Name of the branch to check for.
+  #### Params:
+  - repo (str): Repository to check from.
+  - branch (str): Name of the branch to check for.
 
-	#### Returns:
-	- (bool): True if the branch exists, False otherwise.
-	"""
-	return __ref_exists_in_repo(repo_url, branch, True)
+  #### Returns:
+  - (bool): True if the branch exists, False otherwise.
+  """
+  return __ref_exists_in_repo(repo_url, branch, True)
 
 def tag_exists_in_repo(repo_url: str, tag: str) -> bool:
-	"""
-	### Checks if the given tag exists in the given repository.
-
-	#### Params:
-	- repo_url (str): Repository to check from.
-	- tag (str): Name of the tag to check for.
-
-	#### Returns:
-	- (bool): True if the tag exists, False otherwise.
-	"""
-	return __ref_exists_in_repo(repo_url, tag, False)
-
-def get_clonable_branch(repo_url: str, preferred_branch: str, viable_tag: str) -> Optional[str]:
-	"""
-	### Decides the target to be cloned from a given repository.
-
-	The preferred branch will be selected if exists,
-	followed in priority by the viable tag if provided.
-	Finally, if no branch could be selected, None is returned,
-	meaning that repository's default branch will be used.
-
-	#### Params:
-	- repo_url (str): Url of the repositori to be cloned.
-	- preferred_branch (str): Preferred branch to clone into.
-	- viable_tag (str): If exists, it is returned if branch does not.
-
-	#### Returns:
-	- (str): Name of the branch to clone the repository into.
-	"""
-	if preferred_branch and branch_exists_in_repo(repo_url, preferred_branch):
-		return preferred_branch
-	if viable_tag and tag_exists_in_repo(repo_url, viable_tag):
-		return viable_tag
-	return None
+  """
+  ### Checks if the given tag exists in the given repository.
+
+  #### Params:
+  - repo_url (str): Repository to check from.
+  - tag (str): Name of the tag to check for.
+
+  #### Returns:
+  - (bool): True if the tag exists, False otherwise.
+  """
+  return __ref_exists_in_repo(repo_url, tag, False)
+
+def get_clonable_branch(repo_url: str, preferred_branch: str, viable_tag: Optional[str]) -> Optional[str]:
+  """
+  ### Decides the target to be cloned from a given repository.
+
+  The preferred branch will be selected if exists,
+  followed in priority by the viable tag if provided.
+  Finally, if no branch could be selected, None is returned,
+  meaning that repository's default branch will be used.
+
+  #### Params:
+  - repo_url (str): Url of the repositori to be cloned.
+  - preferred_branch (str): Preferred branch to clone into.
+  - viable_tag (str | None): If exists, it is returned if branch does not.
+
+  #### Returns:
+  - (str | None): Name of the branch to clone the repository into, or None if not found.
+  """
+  if preferred_branch and branch_exists_in_repo(repo_url, preferred_branch):
+    return preferred_branch
+  if viable_tag and tag_exists_in_repo(repo_url, viable_tag):
+    return viable_tag
 
 def execute_git_command_for_source(command: str, source: str) -> Tuple[int, str]:
-	"""
-	### Executes the git command for a specific source.
-
-	#### Params:
-	- command (str): Command to execute on the source.
-	- source (str): The source repository name.
-
-	#### Returns:
-	- (tuple(int, str)): Tuple containing the return code and output message.
-	"""
-	source_path = paths.get_source_path(source)
-	if not os.path.exists(source_path):
-		logger(logger.yellow(
-			f"WARNING: Source {source} does not exist in path {source_path}. Skipping."
-		))
-		return 0, ""
-	
-	return shell_handler.run_shell_command(
-		f"git {command}",
-		cwd=source_path,
-		show_output=True,
-		show_error=True
-	)
+  """
+  ### Executes the git command for a specific source.
+
+  #### Params:
+  - command (str): Command to execute on the source.
+  - source (str): The source repository name.
+
+  #### Returns:
+  - (tuple(int, str)): Tuple containing the return code and output message.
+  """
+  source_path = paths.get_source_path(source)
+  if not os.path.exists(source_path):
+    logger(logger.yellow(
+      f"WARNING: Source {source} does not exist in path {source_path}. Skipping."
+    ))
+    return 0, ""
+  
+  return shell_handler.run_shell_command(
+    f"git {command}",
+    cwd=source_path,
+    show_output=True,
+    show_error=True
+  )
 
 def __ref_exists_in_repo(repo_url: str, ref: str, is_branch: bool) -> bool:
-	"""
-	### Checks if a given reference exists in the given repository.
-
-	#### Params:
-	- repo_url (str): Repository to check from.
-	- ref (str): Reference to check for.
-	- is_branch (bool): If True, the reference is a branch. If False, it is a tag.
-
-	#### Returns:
-	- (bool): True if the ref exists, False otherwise.
-	"""
-	ref_type = "heads" if is_branch else "tags"
-	ret_code, output = shell_handler.run_shell_command(
-		f"git ls-remote --{ref_type} {repo_url}.git refs/{ref_type}/{ref}"
-	)
-	if ret_code:
-		return False
-	return f"refs/{ref_type}/{ref}" in output
+  """
+  ### Checks if a given reference exists in the given repository.
+
+  #### Params:
+  - repo_url (str): Repository to check from.
+  - ref (str): Reference to check for.
+  - is_branch (bool): If True, the reference is a branch. If False, it is a tag.
+
+  #### Returns:
+  - (bool): True if the ref exists, False otherwise.
+  """
+  ref_type = "heads" if is_branch else "tags"
+  ret_code, output = shell_handler.run_shell_command(
+    f"git ls-remote --{ref_type} {repo_url}.git refs/{ref_type}/{ref}"
+  )
+  if ret_code:
+    return False
+  return f"refs/{ref_type}/{ref}" in output