Skip to main content

is_ignored_path

Check if the given path should be ignored or not based on matching one of the glob style ignore_patterns.

def is_ignored_path(
path: string,
ignore_patterns: list
) - > boolean

Check if the given path should be ignored or not based on matching one of the glob style ignore_patterns.

Parameters

NameTypeDescription
pathstringThe file system path to be evaluated against the ignore rules
ignore_patternslistA collection of glob-style strings used to filter out specific files or directories

Returns

TypeDescription
booleanTrue if the path matches any of the provided glob patterns, otherwise False