__init__.py 3.36 KB
Newer Older
J. Fernando Sánchez's avatar
J. Fernando Sánchez committed
1
2
from future import standard_library
standard_library.install_aliases()
3

J. Fernando Sánchez's avatar
J. Fernando Sánchez committed
4
5
import inspect
import os.path
J. Fernando Sánchez's avatar
J. Fernando Sánchez committed
6
import os
7
import pickle
J. Fernando Sánchez's avatar
J. Fernando Sánchez committed
8
import logging
9
import tempfile
J. Fernando Sánchez's avatar
J. Fernando Sánchez committed
10
import copy
11
from .. import models
J. Fernando Sánchez's avatar
J. Fernando Sánchez committed
12
13
14

logger = logging.getLogger(__name__)

15

J. Fernando Sánchez's avatar
J. Fernando Sánchez committed
16
class Plugin(models.Plugin):
17
    def __init__(self, info=None):
J. Fernando Sánchez's avatar
J. Fernando Sánchez committed
18
19
20
21
        """
        Provides a canonical name for plugins and serves as base for other
        kinds of plugins.
        """
22
        if not info:
J. Fernando Sánchez's avatar
J. Fernando Sánchez committed
23
24
            raise models.Error(message=("You need to provide configuration"
                                        "information for the plugin."))
25
        logger.debug("Initialising {}".format(info))
J. Fernando Sánchez's avatar
J. Fernando Sánchez committed
26
        id = 'plugins/{}_{}'.format(info['name'], info['version'])
J. Fernando Sánchez's avatar
J. Fernando Sánchez committed
27
        super(Plugin, self).__init__(id=id, **info)
28
        self.is_activated = False
29

J. Fernando Sánchez's avatar
J. Fernando Sánchez committed
30
31
32
    def get_folder(self):
        return os.path.dirname(inspect.getfile(self.__class__))

33
34
35
36
37
38
39
    def activate(self):
        pass

    def deactivate(self):
        pass


J. Fernando Sánchez's avatar
J. Fernando Sánchez committed
40
41
42
43
SenpyPlugin = Plugin


class AnalysisPlugin(Plugin):
44

45
    def analyse(self, *args, **kwargs):
J. Fernando Sánchez's avatar
J. Fernando Sánchez committed
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
        raise NotImplemented(
            'Your method should implement either analyse or analyse_entry')

    def analyse_entry(self, entry, parameters):
        """ An implemented plugin should override this method.
        This base method is here to adapt old style plugins which only
        implement the *analyse* function.
        Note that this method may yield an annotated entry or a list of
        entries (e.g. in a tokenizer)
        """
        text = entry['text']
        params = copy.copy(parameters)
        params['input'] = text
        results = self.analyse(**params)
        for i in results.entries:
            yield i
62

63

J. Fernando Sánchez's avatar
J. Fernando Sánchez committed
64
class ConversionPlugin(Plugin):
65
    pass
66

67

68
class SentimentPlugin(models.SentimentPlugin, AnalysisPlugin):
69
70
71
72
    def __init__(self, info, *args, **kwargs):
        super(SentimentPlugin, self).__init__(info, *args, **kwargs)
        self.minPolarityValue = float(info.get("minPolarityValue", 0))
        self.maxPolarityValue = float(info.get("maxPolarityValue", 1))
J. Fernando Sánchez's avatar
J. Fernando Sánchez committed
73

74

75
class EmotionPlugin(models.EmotionPlugin, AnalysisPlugin):
76
    def __init__(self, info, *args, **kwargs):
77
        super(EmotionPlugin, self).__init__(info, *args, **kwargs)
J. Fernando Sánchez's avatar
J. Fernando Sánchez committed
78
79
80
81
        self.minEmotionValue = float(info.get("minEmotionValue", -1))
        self.maxEmotionValue = float(info.get("maxEmotionValue", 1))


82
83
class EmotionConversionPlugin(models.EmotionConversionPlugin, ConversionPlugin):
    pass
J. Fernando Sánchez's avatar
J. Fernando Sánchez committed
84
85
86
87
88


class ShelfMixin(object):
    @property
    def sh(self):
J. Fernando Sánchez's avatar
J. Fernando Sánchez committed
89
        if not hasattr(self, '_sh') or self._sh is None:
90
91
92
            self.__dict__['_sh'] = {}
            if os.path.isfile(self.shelf_file):
                self.__dict__['_sh'] = pickle.load(open(self.shelf_file, 'rb'))
J. Fernando Sánchez's avatar
J. Fernando Sánchez committed
93
94
95
96
        return self._sh

    @sh.deleter
    def sh(self):
J. Fernando Sánchez's avatar
J. Fernando Sánchez committed
97
98
        if os.path.isfile(self.shelf_file):
            os.remove(self.shelf_file)
99
100
            del self.__dict__['_sh']
        self.save()
J. Fernando Sánchez's avatar
J. Fernando Sánchez committed
101

J. Fernando Sánchez's avatar
J. Fernando Sánchez committed
102
103
    @property
    def shelf_file(self):
J. Fernando Sánchez's avatar
J. Fernando Sánchez committed
104
        if 'shelf_file' not in self or not self['shelf_file']:
J. Fernando Sánchez's avatar
J. Fernando Sánchez committed
105
106
            sd = os.environ.get('SENPY_DATA', tempfile.gettempdir())
            self.shelf_file = os.path.join(sd, self.name + '.p')
J. Fernando Sánchez's avatar
J. Fernando Sánchez committed
107
        return self['shelf_file']
J. Fernando Sánchez's avatar
J. Fernando Sánchez committed
108

109
    def save(self):
J. Fernando Sánchez's avatar
J. Fernando Sánchez committed
110
        logger.debug('saving pickle')
111
112
113
        if hasattr(self, '_sh') and self._sh is not None:
            with open(self.shelf_file, 'wb') as f:
                pickle.dump(self._sh, f)