utils

analysis_helpers.utils

run_command(command, input_text=None)

Execute a shell command and return the completed subprocess result.

Parameters:

Name	Type	Description	Default
command	str	the shell command to execute	required
input_text	str	the input text to the command. Defaults to None.	None

Returns:

Type	Description
	subprocess.CompletedProcess: completed subprocess result with captured output.

Raises:

Type	Description
CalledProcessError	if the command exits with a non-zero status.

Source code in src/analysis_helpers/utils.py

def run_command(command, input_text=None):
    """Execute a shell command and return the completed subprocess result.

    Args:
        command (str): the shell command to execute
        input_text (str, optional): the input text to the command. Defaults to None.

    Returns:
        subprocess.CompletedProcess: completed subprocess result with captured output.

    Raises:
        subprocess.CalledProcessError: if the command exits with a non-zero status.
    """
    return subprocess.run(
        command,
        input=input_text,
        text=True,
        shell=True,
        check=True,
        stdout=subprocess.PIPE,
        stderr=subprocess.PIPE,
    )

get_temporary_file_name()

Creates a temporary file name

Returns:

Name	Type	Description
str		the temporary file name

Source code in src/analysis_helpers/utils.py

def get_temporary_file_name():
    """Creates a temporary file name

    Returns:
        str: the temporary file name
    """
    with tempfile.NamedTemporaryFile(delete=False) as temp_file:
        temp_file_name = temp_file.name
    return temp_file_name

get_matching_files(directory, pattern)

Get all files in the directory matching the given pattern.

Parameters:

Name	Type	Description	Default
directory	str	The directory to search.	required
pattern	str	The pattern to match files.	required

Returns: list: List of matching file paths.

Source code in src/analysis_helpers/utils.py

def get_matching_files(directory, pattern):
    """Get all files in the directory matching the given pattern.

    Args:
        directory (str): The directory to search.
        pattern (str): The pattern to match files.
    Returns:
        list: List of matching file paths.
    """
    matching_files = []
    for root, dirs, files in os.walk(directory):
        for filename in fnmatch.filter(files, pattern):
            file_path = os.path.join(root, filename)
            matching_files.append(file_path)
    return matching_files