utils

General utilities.

Classes¶

extract_regex_flags(regex_pattern: str) -> Tuple[str, str]

Extract the regex flags from the regex pattern.

Parameters:

Returns:

Tuple[str, str]: A tuple of the regex pattern without the flag string and regex flag string

format_and_raise_error(
    exc: Union[TypeError, subprocess.CalledProcessError]
) -> None

Format the error message from an exception and re-raise it as a BumpVersionError.

get_nested_value(d: dict, path: str) -> Any

Retrieves the value of a nested key in a dictionary based on the given path.

Parameters:

d: The dictionary to search.

TYPE: dict
path: A string representing the path to the nested key, separated by periods.

TYPE: str

Returns:

Raises:

get_overrides(**kwargs) -> dict

Return a dictionary containing only the overridden key-values.

key_val_string(d: dict) -> str

Render the dictionary as a comma-delimited key=value string.

labels_for_format(serialize_format: str) -> List[str]

Return a list of labels for the given serialize_format.

recursive_sort_dict(input_value: Any) -> Any

Sort a dictionary recursively.

run_command(
    command: list, env: Optional[dict] = None
) -> CompletedProcess

Run a shell command and return its output.

set_nested_value(d: dict, value: Any, path: str) -> None

Sets the value of a nested key in a dictionary based on the given path.

Parameters:

d: The dictionary to search.

TYPE: dict
value: The value to set.

TYPE: Any
path: A string representing the path to the nested key, separated by periods.

TYPE: str

Raises: