UserFunc#

class UserFunc(*args, **kwargs)#

Bases: Protocol

Signature of function that can be supplied to be used as a filter.

basic_filter(finder, filename, matches, **kwargs)
Parameters:
  • finder (Finder) – The finder object.

  • filename (str) – The filename to keep or discard.

  • matches (Matches) – The matches associated to this filename.

  • kwargs (Any) – Additional keywords passed to the filter.

Returns:

True if filename is to be kept, False otherwise.