models.py 7.23 KB
Newer Older
J. Fernando Sánchez's avatar
J. Fernando Sánchez committed
1
2
3
4
5
6
7
'''
Senpy Models. 

This implementation should mirror the JSON schema definition.
For compatibility with Py3 and for easier debugging, this new version drops introspection
and adds all arguments to the models.
'''
J. Fernando Sánchez's avatar
J. Fernando Sánchez committed
8
9
10
from __future__ import print_function
from six import string_types

J. Fernando Sánchez's avatar
J. Fernando Sánchez committed
11
12
import time
import copy
13
14
import json
import os
J. Fernando Sánchez's avatar
J. Fernando Sánchez committed
15
import logging
J. Fernando Sánchez's avatar
J. Fernando Sánchez committed
16
17
import jsonref
import jsonschema
J. Fernando Sánchez's avatar
J. Fernando Sánchez committed
18

19
from flask import Response as FlaskResponse
J. Fernando Sánchez's avatar
J. Fernando Sánchez committed
20

21

J. Fernando Sánchez's avatar
J. Fernando Sánchez committed
22
23
DEFINITIONS_FILE = 'definitions.json'
CONTEXT_PATH = os.path.join(os.path.dirname(os.path.realpath(__file__)), 'schemas', 'context.jsonld')
24

J. Fernando Sánchez's avatar
J. Fernando Sánchez committed
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
def get_schema_path(schema_file, absolute=False):
    if absolute:
        return os.path.realpath(schema_file)
    else:
        return os.path.join(os.path.dirname(os.path.realpath(__file__)), 'schemas', schema_file)


def read_schema(schema_file, absolute=False):
    schema_path = get_schema_path(schema_file, absolute)
    schema_uri = 'file://{}'.format(schema_path)
    return jsonref.load(open(schema_path), base_uri=schema_uri)
        

base_schema = read_schema(DEFINITIONS_FILE)
logging.debug(base_schema)

class Context(dict):
42

J. Fernando Sánchez's avatar
J. Fernando Sánchez committed
43
    @staticmethod
J. Fernando Sánchez's avatar
J. Fernando Sánchez committed
44
45
46
47
48
    def load(context):
        logging.debug('Loading context: {}'.format(context))
        if not context:
            return context
        elif isinstance(context, list):
J. Fernando Sánchez's avatar
J. Fernando Sánchez committed
49
50
            contexts = []
            for c in context:
J. Fernando Sánchez's avatar
J. Fernando Sánchez committed
51
                contexts.append(Context.load(c))
J. Fernando Sánchez's avatar
J. Fernando Sánchez committed
52
53
            return contexts
        elif isinstance(context, dict):
J. Fernando Sánchez's avatar
J. Fernando Sánchez committed
54
            return Context(context)
J. Fernando Sánchez's avatar
J. Fernando Sánchez committed
55
        elif isinstance(context, string_types):
J. Fernando Sánchez's avatar
J. Fernando Sánchez committed
56
57
            try:
                with open(context) as f:
J. Fernando Sánchez's avatar
J. Fernando Sánchez committed
58
                    return Context(json.loads(f.read()))
J. Fernando Sánchez's avatar
J. Fernando Sánchez committed
59
60
            except IOError:
                return context
J. Fernando Sánchez's avatar
J. Fernando Sánchez committed
61
62
        else:
            raise AttributeError('Please, provide a valid context')                
63

J. Fernando Sánchez's avatar
J. Fernando Sánchez committed
64
65
66
base_context = Context.load(CONTEXT_PATH)

class SenpyMixin(object):
67
    context = base_context["@context"]
68

69
70
    def flask(self,
              in_headers=False,
71
72
              headers=None,
              **kwargs):
73
        """
74
75
76
        Return the values and error to be used in flask.
        So far, it returns a fixed context. We should store/generate different
        contexts if the plugin adds more aliases.
77
        """
78
79
80
        headers = headers or {}
        kwargs["with_context"] = True
        js = self.jsonld(**kwargs)
81
        if in_headers:
82
83
84
            url = js["@context"]
            del js["@context"]
            headers.update({
85
86
87
                "Link": ('<%s>;'
                         'rel="http://www.w3.org/ns/json-ld#context";'
                         ' type="application/ld+json"' % url)
88
89
            })
        return FlaskResponse(json.dumps(js, indent=2, sort_keys=True),
J. Fernando Sánchez's avatar
J. Fernando Sánchez committed
90
                             status=getattr(self, "status", 200),
91
92
                             headers=headers,
                             mimetype="application/json")
93

J. Fernando Sánchez's avatar
J. Fernando Sánchez committed
94

J. Fernando Sánchez's avatar
J. Fernando Sánchez committed
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
    def serializable(self):
        def ser_or_down(item):
           if hasattr(item, 'serializable'):
               return item.serializable()
           elif isinstance(item, dict):
               temp = dict()
               for kp in item:
                   vp = item[kp]
                   temp[kp] = ser_or_down(vp)
               return temp
           elif isinstance(item, list):
               return list(ser_or_down(i) for i in item)
           else:
               return item
        return ser_or_down(self._plain_dict())
110

111

112
    def jsonld(self, with_context=True, context_uri=None):
J. Fernando Sánchez's avatar
J. Fernando Sánchez committed
113
        ser = self.serializable()
114

J. Fernando Sánchez's avatar
J. Fernando Sánchez committed
115
        if  with_context:
116
117
118
119
120
            context = []
            if context_uri:
                context = context_uri
            else:
                context = self.context.copy()
121
            if hasattr(self, 'prefix'):
122
123
124
125
126
                # This sets @base for the document, which will be used in
                # all relative URIs will. For example, if a uri is "Example" and
                # prefix =s "http://example.com", the absolute URI after expanding
                # with JSON-LD will be "http://example.com/Example"

127
                prefix_context = {"@base": self.prefix}
128
129
130
131
132
                if isinstance(context, list):
                    context.append(prefix_context)
                else:
                    context = [context, prefix_context]
            ser["@context"] = context
J. Fernando Sánchez's avatar
J. Fernando Sánchez committed
133
        return ser
J. Fernando Sánchez's avatar
J. Fernando Sánchez committed
134

135

J. Fernando Sánchez's avatar
J. Fernando Sánchez committed
136
137
138
139
140
    def to_JSON(self, *args, **kwargs):
        js = json.dumps(self.jsonld(*args, **kwargs), indent=4,
                        sort_keys=True)
        return js

141
142
143
144
145
146
    def validate(self, obj=None):
        if not obj:
            obj = self
        if hasattr(obj, "jsonld"):
            obj = obj.jsonld()
        jsonschema.validate(obj, self.schema)
J. Fernando Sánchez's avatar
J. Fernando Sánchez committed
147
148
    
class SenpyModel(SenpyMixin, dict):
149

J. Fernando Sánchez's avatar
J. Fernando Sánchez committed
150
    schema = base_schema
151

152
    def __init__(self, *args, **kwargs):
153
154
155
        self.id = kwargs.pop('id', '{}_{}'.format(type(self).__name__,
                                                    time.time()))

J. Fernando Sánchez's avatar
J. Fernando Sánchez committed
156
157
        temp = dict(*args, **kwargs)

158
159
160
161
162
163
        for i in temp:
            nk = self._get_key(i)
            if nk != i:
                temp[nk] = temp[i]
                del temp[i]

J. Fernando Sánchez's avatar
J. Fernando Sánchez committed
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
        reqs = self.schema.get('required', [])
        for i in reqs:
            if i not in temp:
                prop = self.schema['properties'][i]
                if 'default' in prop:
                    temp[i] = copy.deepcopy(prop['default'])
        if 'context' in temp:
            context = temp['context']
            del temp['context']
            self.__dict__['context'] = Context.load(context)
        super(SenpyModel, self).__init__(temp)


    def _get_key(self, key):
        key = key.replace("__", ":", 1)
        return key

    def __setitem__(self, key, value):
        dict.__setitem__(self, key, value)


    def __delitem__(self, key):
        dict.__delitem__(self, key)

    def __getattr__(self, key):
        try:
            return self.__getitem__(self._get_key(key))
        except KeyError:
            raise AttributeError(key)

    def __setattr__(self, key, value):
        self.__setitem__(self._get_key(key), value)

    def __delattr__(self, key):
        self.__delitem__(self._get_key(key))
        
    
    def _plain_dict(self):
        d =  { k: v for (k,v) in self.items() if k[0] != "_"}
203
        d["@id"] = d.pop('id')
J. Fernando Sánchez's avatar
J. Fernando Sánchez committed
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
        return d

class Response(SenpyModel):
    schema = read_schema('response.json')

class Results(SenpyModel):
    schema = read_schema('results.json')

class Entry(SenpyModel):
    schema = read_schema('entry.json')

class Sentiment(SenpyModel):
    schema = read_schema('sentiment.json')

class Analysis(SenpyModel):
    schema = read_schema('analysis.json')

class EmotionSet(SenpyModel):
    schema = read_schema('emotionSet.json')

224
225
226
class Emotion(SenpyModel):
    schema = read_schema('emotion.json')

J. Fernando Sánchez's avatar
J. Fernando Sánchez committed
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
class Suggestion(SenpyModel):
    schema = read_schema('suggestion.json')

class PluginModel(SenpyModel):
    schema = read_schema('plugin.json')

class Plugins(SenpyModel):
    schema = read_schema('plugins.json')

class Error(SenpyMixin, BaseException ):

    def __init__(self, message, status=500, params=None, errors=None, *args, **kwargs):
        self.message = message
        self.status = status
        self.params = params or {}
        self.errors = errors or ""

    def _plain_dict(self):
       return self.__dict__

    def __str__(self):
       return str(self.jsonld())