/usr/share/pyshared/weboob/capabilities/collection.py is in python-weboob-core 0.g-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 | # -*- coding: utf-8 -*-
# Copyright(C) 2010-2012 Nicolas Duhamel, Laurent Bachelier
#
# This file is part of weboob.
#
# weboob is free software: you can redistribute it and/or modify
# it under the terms of the GNU Affero General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# weboob 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 Affero General Public License for more details.
#
# You should have received a copy of the GNU Affero General Public License
# along with weboob. If not, see <http://www.gnu.org/licenses/>.
from .base import IBaseCap, CapBaseObject, UserError, StringField, Field
__all__ = ['ICapCollection', 'BaseCollection', 'Collection', 'CollectionNotFound']
class CollectionNotFound(UserError):
def __init__(self, split_path=None):
if split_path is not None:
msg = 'Collection not found: %s' % '/'.join(split_path)
else:
msg = 'Collection not found'
UserError.__init__(self, msg)
class BaseCollection(CapBaseObject):
"""
Inherit from this if you want to create an object that is *also* a Collection.
However, this probably will not work properly for now.
"""
def __init__(self, split_path):
CapBaseObject.__init__(self, None)
self.split_path = split_path
@property
def basename(self):
return self.split_path[-1] if self.path_level else None
@property
def parent_path(self):
return self.split_path[0:-1] if self.path_level else None
@property
def path_level(self):
return len(self.split_path)
class Collection(BaseCollection):
"""
A Collection is a "fake" object returned in results, which shows you can get
more results if you go into its path.
It is a dumb object, it must not contain callbacks to a backend.
Do not inherit from this class if you want to make a regular CapBaseObject
a Collection, use BaseCollection instead.
"""
title = StringField('Collection title')
split_path = Field('Full collection path', list)
def __init__(self, split_path, title=None):
self.title = title
BaseCollection.__init__(self, split_path)
def __unicode__(self):
if self.title and self.basename:
return u'%s (%s)' % (self.basename, self.title)
elif self.basename:
return u'%s' % self.basename
else:
return u'Unknown collection'
class ICapCollection(IBaseCap):
def iter_resources_flat(self, objs, split_path, clean_only=False):
"""
Call iter_resources() to fetch all resources in the tree.
If clean_only is True, do not explore paths, only remove them.
split_path is used to set the starting path.
"""
for resource in self.iter_resources(objs, split_path):
if isinstance(resource, Collection):
if not clean_only:
for res in self.iter_resources_flat(objs, resource.split_path):
yield res
else:
yield resource
def iter_resources(self, objs, split_path):
"""
split_path is a list, either empty (root path) or with one or many
components.
"""
raise NotImplementedError()
def get_collection(self, objs, split_path):
"""
Get a collection for a given split path.
If the path is invalid (i.e. can't be handled by this module),
it should return None.
"""
collection = Collection(split_path, None)
return self.validate_collection(objs, collection) or collection
def validate_collection(self, objs, collection):
"""
Tests if a collection is valid.
For compatibility reasons, and to provide a default way, it checks if
the collection has at least one object in it. However, it is not very
efficient or exact, and you are encouraged to override this method.
You can replace the collection object entirely by returning a new one.
"""
# Root
if collection.path_level == 0:
return
try:
i = self.iter_resources(objs, collection.split_path)
i.next()
except StopIteration:
raise CollectionNotFound(collection.split_path)
def _restrict_level(self, split_path, lmax=0):
if len(split_path) > lmax:
raise CollectionNotFound(split_path)
def test():
c = Collection([])
assert c.basename is None
assert c.parent_path is None
assert c.path_level == 0
c = Collection([u'lol'])
assert c.basename == u'lol'
assert c.parent_path == []
assert c.path_level == 1
c = Collection([u'lol', u'cat'])
assert c.basename == u'cat'
assert c.parent_path == [u'lol']
assert c.path_level == 2
c = Collection([u'w', u'e', u'e', u'b', u'o', u'o', u'b'])
assert c.basename == u'b'
assert c.parent_path == [u'w', u'e', u'e', u'b', u'o', u'o']
assert c.path_level == 7
|