File: feed.py

package info (click to toggle)
python-pypump 0.3%2Bgit20130823.1.97bffc6-1
  • links: PTS, VCS
  • area: main
  • in suites: jessie, jessie-kfreebsd
  • size: 328 kB
  • ctags: 333
  • sloc: python: 1,630; makefile: 140; sh: 7
file content (211 lines) | stat: -rw-r--r-- 6,317 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
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
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
203
204
205
206
207
208
209
210
211
##
# Copyright (C) 2013 Jessica T. (Tsyesika) <xray7224@googlemail.com>
# 
# This program is free software: you can redistribute it and/or modify 
# it under the terms of the GNU General Public License as published by 
# the Free Software Foundation, either version 3 of the License, or 
# (at your option) any later version. 
# 
# This program is distributed in the hope that it will be useful, 
# but WITHOUT ANY WARRANTY; without even the implied warranty of 
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 
# GNU General Public License for more details. 
# 
# You should have received a copy of the GNU General Public License 
# along with this program. If not, see <http://www.gnu.org/licenses/>.
##

from pypump.compatability import *
from pypump.exception import PyPumpException 
from pypump.models import AbstractModel

class InfiniteFeed(object):
    
    previous = None

    def __init__(self, feed, offset=None, count=20, stop=None, step=1):
        self.feed = feed
        self.count = count
        self.maxcount = 200 # upper API limit for requested items
        self.offset = offset
        self.cache = list()
        self.counter = 0
        self.stop = stop
        self.step = step

    def __iter__(self):
        return self

    def next(self):
        if not self.cache:
            if self.previous is None:
                # first iteration
                response = self.feed._request(count=self.count, offset=self.offset)
            else:
                response = self.feed._request(count=self.count, before=self.previous)
            self.cache = response['items']
        data = self.cache.pop(0) if self.cache else None

        if not data or (self.stop and self.counter >= self.stop):
            # we're done
            raise StopIteration

        if self.counter > self.count:
            # raise count if we iterate a lot
            if self.counter < self.maxcount:
                self.count = self.counter
            else:
                self.count = self.maxcount
        
        obj = getattr(self.feed._pump, self.feed.OBJECT_TYPES)
        obj = obj.unserialize(data)
        self.previous = obj.id
        self.counter += 1
        if (self.counter-1) % self.step == 0:
            return obj
        else:
            return self.next()

@implement_to_string
class Feed(AbstractModel):

    _count = None
    _offset = None
    actor = None
    author = actor

    _ENDPOINT = None
    @property
    def ENDPOINT(self):
        if self._ENDPOINT is None:
            raise NotImplemented("Definition of the ENDPOINT must be done by subclass")
        return self._ENDPOINT

    @property
    def major(self):
        endpoint = self.ENDPOINT
        if not endpoint.endswith("/"):
            endpoint += "/"
        endpoint += "major"
        return self.__class__(username=self.actor, endpoint=endpoint)

    @property
    def minor(self):
        endpoint = self.ENDPOINT
        if not endpoint.endswith("/"):
            endpoint += "/"
        endpoint += "minor"
        return self.__class__(username=self.actor, endpoint=endpoint)

    def __init__(self, username=None, endpoint=None):
        if endpoint is not None:
            self._ENDPOINT = endpoint
        
        if isinstance(username, self._pump.Person):
            self.actor = username
            return

        self.actor = self._pump.Person(username)        

    def __getitem__(self, key):
        """ Adds Feed[<feed>] """
        if isinstance(key, slice):
            return self.__getslice__(key)
        count = 1
        offset = key
        inf = InfiniteFeed(self, offset=offset, count=count, stop=count)
        return inf.next()

    def __getslice__(self, s, e=None):
        """ Grab multiple items from feed """
        if type(s) is not slice:
            s = slice(s,e)

        if s.start and s.stop:
            count = s.stop - s.start
            offset = s.start
        elif s.stop:
            count = s.stop
            offset = None
        elif s.start:
            offset = s.start
            count = None
        if s.step:
            step = s.step
        else:
            step = 1

        return InfiniteFeed(self, offset=offset, stop=count, step=step)

    def __iter__(self):
        """ Produces an iterator """
        return InfiniteFeed(self) 
    
    def __repr__(self):
        if self.author:
            return "<{type}: {actor}>".format(
                    actor=self.actor,
                    type=self.TYPE,
                    )
        else:
            return "<{type}>".format(type=self.TYPE)
    
    def __str__(self):
        return str(repr(self))

    def _request(self, offset=None, count=None, since=None, before=None):
        """ Makes a request """
        param = dict()

        if count is not None:
            param["count"] = count

        if offset is not None:
            param["offset"] = offset

        if since is not None:
            param["since"] = before
        elif before is not None:
            param["before"] = before

        if self.actor is None:
            # oh dear, we gotta raise an error
            raise PyPumpException("No actor defined on {feed}".format(feed=self))

        data = self._pump.request(self.ENDPOINT, params=param)

        return data

    @classmethod
    def unserialize(cls, data, user=None):
        """ Produce a List from JOSN data """
        if type(data) == list:
            items = data
        elif type(data) == dict:
            items = data["items"]
        else:
            raise Exception("Unknown type: {type} ('{data}')".format(
                    type=type(data),
                    data=data
                    ))

        unserialized_items = list()

        for v in items:
            # do we know about it?
            obj_type = cls.OBJECT_TYPES

            # todo: make less hacky
            try:
                obj = getattr(cls._pump, obj_type)
            except AttributeError:
                continue # what is this stange type of which you are?
            
            try:
                real_obj = obj.unserialize(v)
                if real_obj is not None:
                    unserialized_items.append(real_obj)
            except TypeError:
                pass

        return unserialized_items