weboob-devel/weboob/tools/path.py
Laurent Bachelier b4b7182960 Make Collection more safe and sane
* 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
2012-03-13 22:08:45 +01:00

95 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 copy import copy
from posixpath import sep, join
class WorkingPath(object):
def __init__(self):
self.split_path = []
self.previous = copy(self.split_path)
def cd1(self, user_input):
"""
Append *one* level to the current path.
This means that separators (/) will get escaped.
"""
split_path = self.get()
split_path.append(user_input)
self.location(split_path)
def location(self, split_path):
"""
Go to a new path, and store the previous path.
"""
self.previous = self.get()
self.split_path = split_path
def restore(self):
"""
Go to the previous path
"""
self.split_path, self.previous = self.previous, self.split_path
def home(self):
"""
Go to the root
"""
self.location([])
def up(self):
"""
Go up one directory
"""
self.location(self.split_path[:-1])
def get(self):
"""
Get the current working path
"""
return copy(self.split_path)
def __unicode__(self):
return join(sep, *[s.replace(u'/', u'\/') for s in self.split_path])
def test():
wp = WorkingPath()
assert wp.get() == []
assert unicode(wp) == u'/'
wp.cd1(u'lol')
assert wp.get() == [u'lol']
assert unicode(wp) == u'/lol'
wp.cd1(u'cat')
assert wp.get() == [u'lol', u'cat']
assert unicode(wp) == u'/lol/cat'
wp.restore()
assert unicode(wp) == u'/lol'
wp.home()
assert wp.get() == []
assert unicode(wp) == u'/'
wp.up()
assert wp.get() == []
assert unicode(wp) == u'/'
wp.location(['aa / aa', 'bbbb'])
assert unicode(wp) == u'/aa \/ aa/bbbb'
wp.up()
assert unicode(wp) == u'/aa \/ aa'
wp.cd1(u'héhé/hé')
assert unicode(wp) == u'/aa \/ aa/héhé\/hé'