b4b7182960
* Remove callbacks in Collection object Make Collection a "dumb" object (and also a base object, though it isn't very useful for now) * Rename Path to WorkingPath, because it is more about managing state than being a single path. * Rewrite almost all WorkingPath, because the code was overly complicated for no reason (I tried some special cases and it turned out that fromstring didn't handle them, and that the quote-escape-unquote was just unecessary). I also rewrote it to be more pythonic (no more lambdas and maps) and added tests. * Require the full split path when creating a Collection. Because, come to think of it, an object needs an unique identifier; in the case of Collections, it is the full path, not only its last part. I might even replace the id by the full split path in the future. * There is now only one way to get items of a Collection: calling iter_resources(). * Rewrite flatten_resources to iter_resources_flat(), which just calls iter_resources() recursively. * Rewrite the collection part of the canalplus module. There is no more callback or a page calling the browser to check another page! The logic is only in iter_resources(). The resulting code is not very pretty, but it should get better. As a bonus, avoid to reload the main XML file when we already have it open. * change_path() now expects a split path and not a string. * up/home special cases for "cd" are handled in the same place, and store the previous place properly (but are not yet exploitable by an user command). This is a big commit but it would be hard to split it in *working* commits. If you read this entire commit message, I will buy you a beer. refs #774 fixes #773
76 lines
2.6 KiB
Python
76 lines
2.6 KiB
Python
# -*- 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
|
|
|
|
__all__ = ['ICapCollection', 'Collection', 'CollectionNotFound']
|
|
|
|
|
|
class CollectionNotFound(Exception):
|
|
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'
|
|
Exception.__init__(self, msg)
|
|
|
|
|
|
class Collection(CapBaseObject):
|
|
"""
|
|
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.
|
|
"""
|
|
def __init__(self, split_path, backend=None, title=None):
|
|
self.split_path = split_path
|
|
self.title = title
|
|
_id = split_path[-1] if len(split_path) else None
|
|
CapBaseObject.__init__(self, _id, backend)
|
|
|
|
def __unicode__(self):
|
|
if self.title and self.id:
|
|
return u'%s (%s)' % (self.id, self.title)
|
|
elif self.id:
|
|
return u'%s' % self.id
|
|
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()
|