diff -r 7685cec9fd3c -r f2ddfa555b0f doc/api/python/fileutils.AbstractScanner-class.html --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/doc/api/python/fileutils.AbstractScanner-class.html Fri Sep 11 11:54:49 2009 +0100 @@ -0,0 +1,519 @@ + + + + + fileutils.AbstractScanner + + + + + + + + + + + + + + + + + + + + +
   Trees      Indices      Help   
+ + + + + +
+ + Module fileutils :: + Class AbstractScanner + + + + + + +
[hide private]
[frames] | no frames]
+
+ +

Class AbstractScanner

source code

+
+object --+
+         |
+        AbstractScanner
+
+ +
+This class implements all the required infrastructure for filescanning.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
Instance Methods[hide private]
+
+   + + + + + + +
__init__(self)
+ Initialization.		 + source code + +
+ +
+   + + + + + + +
add_include(self, + include)
+ Adds an include path to the scanner.		 + source code + +
+ +
+   + + + + + + +
add_exclude(self, + exclude)
+ Adds an exclude path to the scanner.		 + source code + +
+ +
+   + + + + + + +
add_exclude_file(self, + exclude)
+ Adds an exclude file to the scanner.		 + source code + +
+ +
+   + + + + + + +
add_selector(self, + selector)
+ Add selector to the scanner.		 + source code + +
+ +
+   + + + + + + +
add_filetype(self, + filetype)
+ Adds a filetype selection to the scanner.		 + source code + +
+ +
+   + + + + + + +
is_included(self, + path)
+ Returns if path is included by the scanner.		 + source code + +
+ +
+   + + + + + + +
is_excluded(self, + path)
+ Returns if path is excluded by the scanner.		 + source code + +
+ +
+   + + + + + + +
is_selected(self, + path)
+ Returns if path is selected by all selectors in the scanner.		 + source code + +
+ +
+   + + + + + + +
is_filetype(self, + path)
+ Test if a file matches one filetype.		 + source code + +
+ +
+   + + + + + + +
match(self, + filename, + pattern)
+ Is filename matching pattern?		 + source code + +
+ +
+   + + + + + + +
test_path(self, + root, + relpath)
+ Test if a path matches filetype, include, exclude, and selection process.		 + source code + +
+ +
+   + + + + + + +
__str__(self)
+ Returns a string representing this instance.		 + source code + +
+ +
+   + + + + + + +
__repr__(self)
+ Returns a string representing this instance.		 + source code + +
+ +
+   + + + + + + +
scan(self)
+ Abstract method which much be overriden to implement the scanning process.		 + source code + +
+ +
+

Inherited from object: + __delattr__, + __getattribute__, + __hash__, + __new__, + __reduce__, + __reduce_ex__, + __setattr__ +

+
+ + + + + + + + + +
+ + + + + +
Properties[hide private]
+
+

Inherited from object: + __class__ +

+
+ + + + + + +
+ + + + + +
Method Details[hide private]
+
+ +
+ +
+ + +
+

__init__(self) +
(Constructor) +

+ 		source code  +
+ + Initialization. +
+
Overrides: + object.__init__ +
+
+
+
+ +
+ +
+ + +
+

__str__(self) +
(Informal representation operator) +

+ 		source code  +
+ + Returns a string representing this instance. +
+
Overrides: + object.__str__ +
+
+
+
+ +
+ +
+ + +
+

__repr__(self) +
(Representation operator) +

+ 		source code  +
+ + Returns a string representing this instance. +
+
Overrides: + object.__repr__ +
+
+
+
+
+ + + + + + + + + + + + + + + +
   Trees      Indices      Help   
+ + + + + +
+ Generated by Epydoc 3.0beta1 on Wed Sep 09 13:44:18 2009 + + http://epydoc.sourceforge.net +
+ + + + +