setuptools._distutils.filelist.FileList

class documentation

class FileList: (source)

View In Hierarchy

A list of files built by on exploring the filesystem and filtered by applying various patterns to what we find there. Instance attributes: dir directory from which files will be taken -- only used if 'allfiles' not supplied to constructor files list of filenames currently being built/filtered/manipulated allfiles complete list of files under consideration (ie. without any filtering applied)

Method __init__ Undocumented
Method append Undocumented
Method debug_print Print 'msg' to stdout if the global DEBUG (taken from the DISTUTILS_DEBUG environment variable) flag is true.
Method exclude_pattern Remove strings (presumably filenames) from 'files' that match 'pattern'. Other parameters are the same as for 'include_pattern()', above. The list 'self.files' is modified in place. Return True if files are found, False otherwise.
Method extend Undocumented
Method findall Undocumented
Method include_pattern Select strings (presumably filenames) from 'self.files' that match 'pattern', a Unix-style wildcard (glob) pattern. Patterns are not quite the same as implemented by the 'fnmatch' module: '*' and '?' ...
Method process_template_line Undocumented
Method remove_duplicates Undocumented
Method set_allfiles Undocumented
Method sort Undocumented
Instance Variable allfiles Undocumented
Instance Variable files Undocumented
Method _parse_template_line Undocumented
def __init__(self, warn=None, debug_print=None): (source)

Undocumented

def append(self, item): (source)

Undocumented

def debug_print(self, msg): (source)

Print 'msg' to stdout if the global DEBUG (taken from the DISTUTILS_DEBUG environment variable) flag is true.

def exclude_pattern(self, pattern, anchor=1, prefix=None, is_regex=0): (source)

Remove strings (presumably filenames) from 'files' that match 'pattern'. Other parameters are the same as for 'include_pattern()', above. The list 'self.files' is modified in place. Return True if files are found, False otherwise.

def extend(self, items): (source)

Undocumented

def findall(self, dir=os.curdir): (source)

Undocumented

def include_pattern(self, pattern, anchor=1, prefix=None, is_regex=0): (source)

Select strings (presumably filenames) from 'self.files' that match 'pattern', a Unix-style wildcard (glob) pattern. Patterns are not quite the same as implemented by the 'fnmatch' module: '*' and '?' match non-special characters, where "special" is platform- dependent: slash on Unix; colon, slash, and backslash on DOS/Windows; and colon on Mac OS. If 'anchor' is true (the default), then the pattern match is more stringent: "*.py" will match "foo.py" but not "foo/bar.py". If 'anchor' is false, both of these will match. If 'prefix' is supplied, then only filenames starting with 'prefix' (itself a pattern) and ending with 'pattern', with anything in between them, will match. 'anchor' is ignored in this case. If 'is_regex' is true, 'anchor' and 'prefix' are ignored, and 'pattern' is assumed to be either a string containing a regex or a regex object -- no translation is done, the regex is just compiled and used as-is. Selected strings will be added to self.files. Return True if files are found, False otherwise.

def process_template_line(self, line): (source)

Undocumented

def remove_duplicates(self): (source)

Undocumented

def set_allfiles(self, allfiles): (source)

Undocumented

def sort(self): (source)

Undocumented

allfiles = (source)

Undocumented

files: list = (source)

Undocumented

def _parse_template_line(self, line): (source)

Undocumented