Utilities

Helper functions and utilities for logging and common operations.

Logger

getLogger(name)

Source code in ivcap_service/logger.py

def getLogger(name: str) -> logging.Logger:
    return logging.getLogger(name)

Logging Initialization

logging_init(cfg_path=None)

Source code in ivcap_service/logger.py

def logging_init(cfg_path: str | None = None):
    if not cfg_path:
        script_dir = os.path.dirname(__file__)
        cfg_path = os.path.join(script_dir, "logging.json")

    with open(cfg_path) as file:
        config = json.load(file)
        set_service_log_config(config)

General Utilities

utils

get_input_type(func)

Gets the input type of a function.

Parameters:

Name	Type	Description	Default
func	Callable	The function to get the input type for.	required

Returns:

Type	Description
tuple[type[BaseModel] | None, dict[str, Any]]	A tuple containing: - The first function parameter which is a derived class of a pydantic BaseModel, or None if no such parameter exists. - A dictionary of all additional parameters, where the key is the parameter name and the value is the type.

Source code in ivcap_service/utils.py

def get_input_type(
    func: Callable,
) -> tuple[type[BaseModel] | None, dict[str, Any]]:
    """Gets the input type of a function.

    Args:
        func: The function to get the input type for.

    Returns:
        A tuple containing:
        - The first function parameter which is a derived class of a pydantic BaseModel, or None if no such parameter exists.
        - A dictionary of all additional parameters, where the key is the parameter name and the value is the type.
    """
    signature = inspect.signature(func)
    type_hints: dict[str, Any] = get_type_hints(func)

    # Get the Pydantic model class
    pydantic_model_class = None
    pydantic_param_name = None
    for param_name, param in signature.parameters.items():
        if (
            hasattr(param.annotation, "__mro__")
            and BaseModel in param.annotation.__mro__
        ):
            pydantic_model_class = param.annotation
            pydantic_param_name = param_name
            break

    # Get all additional parameters
    additional_params = {}
    for param_name, param in signature.parameters.items():
        if param_name != pydantic_param_name:
            param_type = type_hints.get(param_name, Any)
            additional_params[param_name] = param_type

    return pydantic_model_class, additional_params

get_function_return_type(func)

Extracts the return type from a function.

Source code in ivcap_service/utils.py

def get_function_return_type(func: Callable) -> Any | None:
    """Extracts the return type from a function."""
    type_hints: dict[str, Any] = get_type_hints(func)
    # param_types = {k: v for k, v in type_hints.items() if k != 'return'}
    return_type = type_hints.get("return")
    # return param_types, return_type
    return return_type

file_to_json(file_path)

Reads a file, attempts to parse it as JSON, and returns the content.

Parameters:

Name	Type	Description	Default
file_path	str	The path to the file to read.	required

Returns:

Type	Description
dict[str, Any]	A dictionary containing the parsed JSON content.

Raises:

Type	Description
FileNotFoundError	If the file does not exist.
ValueError	If the file is not a valid JSON file.
IOError	If there is an error reading the file.

Source code in ivcap_service/utils.py

def file_to_json(file_path: str) -> dict[str, Any]:
    """
    Reads a file, attempts to parse it as JSON, and returns the content.

    Args:
        file_path: The path to the file to read.

    Returns:
        A dictionary containing the parsed JSON content.

    Raises:
        FileNotFoundError: If the file does not exist.
        ValueError: If the file is not a valid JSON file.
        IOError: If there is an error reading the file.
    """
    if not os.path.exists(file_path):
        raise FileNotFoundError(f"File not found: {file_path}")

    try:
        with open(file_path) as f:
            return json.load(f)
    except FileNotFoundError as e:
        raise FileNotFoundError(f"Error finding file: {file_path}: {e}")
    except json.JSONDecodeError as e:
        raise ValueError(f"Error decoding JSON from file: {file_path}: {e}")
    except Exception as e:
        raise OSError(f"Error reading file: {file_path}: {e}")

clean_description(text)

Cleans a string by removing unnecessary whitespace and newlines, while preserving double newlines.

Source code in ivcap_service/utils.py

def clean_description(text: str) -> str:
    """
    Cleans a string by removing unnecessary whitespace and newlines, while preserving double newlines.
    """
    text = text.replace("\n\n", "TEMP_NEWLINE")
    text = text.replace("\n", " ")
    text = " ".join(text.split())
    text = text.replace("TEMP_NEWLINE", "\n")
    return text

Copy Markdown