suggest_similar

Function

This function is defined in the parse_utils module.

Find the most similar string from candidates using Levenshtein distance. This function is ONLY called on error paths, never on happy paths.

Signature

def suggest_similar(value: str, candidates: Iterable[str], max_distance: int) -> Optional[str]

value

str

required

The invalid value

candidates

Iterable

required

Valid options to compare against

max_distance

int

default:"2"

Maximum edit distance to consider a match

Optional[str]

Most similar candidate if within max_distance, None otherwise