venvmod.tools module

Regroups tool for the package.

venvmod.tools.check_raise(condition: bool, exception_type: Exception, message: str)[source]

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_

venvmod.tools.get_shell_name_command() → str[source]

Gets command to get shell name..

Returns

Command as str.

Return type

str

venvmod.tools.get_shell_name() → str[source]

Gets current shell name.

Returns

shell name

Return type

str

venvmod.tools.get_process_result(command: str, capture_output: bool, cwd: Optional[str] = None) → subprocess.CompletedProcess[source]

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

Process result

Return type

CompletedProcess

venvmod.tools.run_process(command: str, verbose: bool, do_raise: bool, cwd: Optional[str] = None) → int[source]

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

return code

Return type

int

venvmod.tools.remove_duplicates(input_list: List) → List[source]

Removes duplicate values in a list.

Parameters

input_list (List) – Input list.

Returns

Output list.

Return type

List

venvmod.tools.get_std_name(name: str) → str[source]
Transform a name in standard name:

  • lower case

  • ‘_’ -> ‘-’

Parameters

name (str) – input name

Returns

standardized name

Return type

str