class documentation

class IgnoreFilter(object):

View In Hierarchy

Undocumented

Class Method from_path Undocumented
Method __init__ Undocumented
Method __repr__ Undocumented
Method append_pattern Add a pattern to the set.
Method find_matching Yield all matching patterns for path.
Method is_ignored Check whether a path is ignored.
Instance Variable _ignorecase Undocumented
Instance Variable _path Undocumented
Instance Variable _patterns Undocumented
@classmethod
def from_path(cls, path, ignorecase=False):

Undocumented

Parameters
pathUndocumented
ignorecase:boolUndocumented
Returns
IgnoreFilterUndocumented
def __init__(self, patterns, ignorecase=False, path=None):

Undocumented

Parameters
patterns:Iterable[bytes]Undocumented
ignorecase:boolUndocumented
pathUndocumented
def __repr__(self):

Undocumented

Returns
strUndocumented
def append_pattern(self, pattern):

Add a pattern to the set.

Parameters
pattern:bytesUndocumented
def find_matching(self, path):

Yield all matching patterns for path.

Parameters
path:Union[bytes, str]Path to match
Returns
Iterable[Pattern]Iterator over iterators
def is_ignored(self, path):

Check whether a path is ignored.

For directories, include a trailing slash.

Returns: status is None if file is not mentioned, True if it is
included, False if it is explicitly excluded.
Parameters
path:bytesUndocumented
Returns
Optional[bool]Undocumented
_ignorecase =

Undocumented

_path =

Undocumented

_patterns: List[Pattern] =

Undocumented