File: mapper.py

package info (click to toggle)
w3af 1.0-rc3svn3489-1
  • links: PTS
  • area: main
  • in suites: jessie, jessie-kfreebsd, squeeze, wheezy
  • size: 59,908 kB
  • ctags: 16,916
  • sloc: python: 136,990; xml: 63,472; sh: 153; ruby: 94; makefile: 40; asm: 35; jsp: 32; perl: 18; php: 5
file content (66 lines) | stat: -rw-r--r-- 1,796 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
from inputformat import TextLineInput
from outputcollector import LineOutput


class MapperBase:
    """ 
    Base class for every map tasks
    
    Your map class should extend this base class 
    and override the map function
    """

    def __init__(self):
        """
        set the default input formatter and output collector
        """
        self.inputformat = TextLineInput
        self.outputcollector = LineOutput

    def set_inputformat(self, format):
        """
        set the input formatter for map task

        @param format: the input formatter to parse the input
        """

        self.inputformat = format
    
    def set_outputcollector(self, collector):
        """
        set the output collector for map task 

        @param collector: the ouput collector to collect output
        """

        self.outputcollector = collector

    def map(self, key, value):
        """
        do map operation on each (key, value) pair

        It is the only function needs to and 
        have to be implemented in your own class

        It is a callback function that is called in C{call_map()} function
        you should not call this function directly

        the actual content of key and value is determined by the inputformat

        @param key: key part in (key, value) pair
        @type key: C{string}
        @param value: value part in (key, value) pair
        @type value: C{string}
        """

        raise NotImplementedError('map() is not implemented in this class')

    def call_map(self):
        """ 
        driver function for map task, you should call this method 
        instead of the map method in main function 
        """

        data = self.inputformat.read_line()
        for key, value in data:
            self.map(key, value)