Skip to main content

BaseFinder

A base file finder to be used for custom staticfiles finder classes.

Methods


check()

@classmethod
def check(
**kwargs: dict
) - > list

Verifies that the finder is configured correctly by performing validation checks.

Parameters

NameTypeDescription
**kwargsdictArbitrary keyword arguments passed to the check method for context-specific validation.

Returns

TypeDescription
listA list of error or warning messages encountered during the configuration check.

list()

@classmethod
def list(
ignore_patterns: list
) - > iterable

Given an optional list of paths to ignore, return a two item iterable consisting of the relative path and storage instance.

Parameters

NameTypeDescription
ignore_patternslistA list of file or directory patterns to exclude from the search results.

Returns

TypeDescription
iterableA two-item iterable containing the relative file path and the associated storage instance.