distutils.filelist
index
/usr/lib/python2.1/distutils/filelist.py

distutils.filelist
 
Provides the FileList class, used for poking about the filesystem
and building lists of files.

 
Modules
            
fnmatch
os
re
string
sys

 
Classes
            
FileList

 
class FileList
      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)
 
  
_FileList__debug_print = __debug_print(self, msg)
Print 'msg' to stdout if the global DEBUG (taken from the
DISTUTILS_DEBUG environment variable) flag is true.
_FileList__warn = __warn(self, msg)
__init__(self, warn=None, debug_print=None)
_parse_template_line(self, line)
append(self, item)
exclude_pattern(self, pattern, anchor=1, prefix=None, is_regex=0)
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 1 if files are found.
extend(self, items)
findall(self, dir='.')
include_pattern(self, pattern, anchor=1, prefix=None, is_regex=0)
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 1 if files are found.
process_template_line(self, line)
remove_duplicates(self)
set_allfiles(self, allfiles)
sort(self)

 
Functions
            
findall(dir='.')
Find all files under 'dir' and return the list of full filenames
(relative to 'dir').
glob_to_re(pattern)
Translate a shell-like glob pattern to a regular expression; return
a string containing the regex.  Differs from 'fnmatch.translate()' in
that '*' does not match "special characters" (which are
platform-specific).
translate_pattern(pattern, anchor=1, prefix=None, is_regex=0)
Translate a shell-like wildcard pattern to a compiled regular
expression.  Return the compiled regex.  If 'is_regex' true,
then 'pattern' is directly compiled to a regex (if it's a string)
or just returned as-is (assumes it's a regex object).

 
Data
             BufferType = <type 'buffer'>
BuiltinFunctionType = <type 'builtin_function_or_method'>
BuiltinMethodType = <type 'builtin_function_or_method'>
ClassType = <type 'class'>
CodeType = <type 'code'>
ComplexType = <type 'complex'>
DictType = <type 'dictionary'>
DictionaryType = <type 'dictionary'>
EllipsisType = <type 'ellipsis'>
FileType = <type 'file'>
FloatType = <type 'float'>
FrameType = <type 'frame'>
FunctionType = <type 'function'>
InstanceType = <type 'instance'>
IntType = <type 'int'>
LambdaType = <type 'function'>
ListType = <type 'list'>
LongType = <type 'long int'>
MethodType = <type 'instance method'>
ModuleType = <type 'module'>
NoneType = <type 'None'>
SliceType = <type 'slice'>
StringType = <type 'string'>
TracebackType = <type 'traceback'>
TupleType = <type 'tuple'>
TypeType = <type 'type'>
UnboundMethodType = <type 'instance method'>
UnicodeType = <type 'unicode'>
XRangeType = <type 'xrange'>
__file__ = '/usr/lib/python2.1/distutils/filelist.pyc'
__name__ = 'distutils.filelist'
__revision__ = '$Id: filelist.py,v 1.8 2000/09/26 02:02:51 gward Exp $'