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

Class Scanner

source code

+
+               object --+    
+                        |    
+fileutils.AbstractScanner --+
+                            |
+                           Scanner
+
+ +
+Abstract class that represent and input source.

+ + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
Instance Methods[hide private]
+
+   + + + + + + +
__init__(self, + config)
+ Initialization.
+ source code + +
+ +
+   + + + + + + +
setup(self)
+ Setting up the scanner.
+ source code + +
+ +
+   + + + + + + +
add_exclude_lst(self, + filename)
+ Adding excludes from exclude list.
+ source code + +
+ +
+   + + + + + + +
scan(self)
+ Generator method that scan the relevant input source.
+ source code + +
+ +
+

Inherited from fileutils.AbstractScanner: + __repr__, + __str__, + add_exclude, + add_exclude_file, + add_filetype, + add_include, + add_selector, + is_excluded, + is_filetype, + is_included, + is_selected, + match, + test_path +

+

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

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

Inherited from object: + __class__ +

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

__init__(self, + config) +
(Constructor) +

+
source code  +
+ + Initialization. +
+
Overrides: + fileutils.AbstractScanner.__init__ +
(inherited documentation)
+ +
+
+
+ +
+ +
+ + +
+

scan(self) +

+
source code  +
+ + Generator method that scan the relevant input source. +This method need to be overloaded by the specialized class. +return fullpath name +
+
Overrides: + fileutils.AbstractScanner.scan +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + +
+ + + + +