"""Regroups tool for the package.
"""
import logging
from pathlib import Path
from subprocess import run as _run_process, CompletedProcess, PIPE
from typing import List
import shellingham
from venvmod import __name__ as PACKAGE_NAME
logger = logging.getLogger(PACKAGE_NAME)
[docs]def check_raise(condition: bool, exception_type: Exception, message: str):
"""Chack if a condition is True to raise
Parameters
----------
condition : bool
Condition to be True to raise
exception_type : Exception
Exception to raise
message : str
Message for the exception
Raises
------
exception_type
_description_
"""
if condition:
logger.error(message)
raise exception_type(message)
[docs]def get_shell_name() -> str:
"""Gets current shell name.
Returns
-------
str
shell name
"""
return shellingham.detect_shell()[0]
[docs]def get_shell_command() -> str:
"""Gets current shell name.
Returns
-------
str
shell command
"""
return shellingham.detect_shell()[1]
[docs]def get_process_result(command: str,
capture_output: bool,
cwd: str or Path = None) -> CompletedProcess:
"""Run procces and get results
Parameters
----------
command : str
command to run
capture_output : bool
True to capture output
cwd : str or Path, optional
execution directory, by default None
Returns
-------
CompletedProcess
Process result
"""
pipe = PIPE if capture_output else None
return _run_process([get_shell_command(), '-c', command],
stderr=pipe, stdout=pipe, cwd=cwd) # pylint: disable=subprocess-run-check
[docs]def run_process(command: str, verbose: bool, do_raise: bool, cwd: str or Path = None) -> int:
"""Run process
Parameters
----------
command : str
command to run
verbose : bool
to enable verbosity
do_raise : bool
If True, raise if fails
cwd : str or Path, optional
execution directory, by default None
Returns
-------
int
return code
"""
result = get_process_result(command=command, capture_output=not verbose, cwd=cwd)
if do_raise:
result.check_returncode()
return result.returncode
[docs]def remove_duplicates(input_list: List) -> List:
"""Removes duplicate values in a list.
Parameters
----------
input_list : List
Input list.
Returns
-------
List
Output list.
"""
return [value for index, value in enumerate(input_list) if value not in input_list[index+1:]]
[docs]def get_std_name(name: str) -> str:
"""Transform a name in standard name:
- lower case
- '_' -> '-'
Parameters
----------
name : str
input name
Returns
-------
str
standardized name
"""
return name.lower().replace("_", "-")