Make CapCollection understandable and useable by humans

* Make the declaration of fct and it in the constructor Collection,
 instead of adding them from the outside
* Add a function to flatten a list containing collection (solves the
 radioob search crash)
* Better display of collections in the "ls" command (and display both id
 and title)
* The "cd" command goes to the root of the path (like the UNIX cd)
* Move the Video object of canalplus in a correct path
* Make Collection iterable
* Add comments to CapCollection
* Cache the result of fct in a Collection; it is only called once
* CollectionNotFound errors can be more explicit by providing a path
* Require utf-8 in collection paths
* Code cleanups

modules/canalplus/backend.py

@@ -27,7 +27,7 @@ from weboob.tools.backend import BaseBackend, BackendConfig
 from weboob.tools.value import Value
 
 from .browser import CanalplusBrowser
-from .pages import CanalplusVideo
+from .video import CanalplusVideo
 
 from weboob.capabilities.collection import ICapCollection
 

modules/canalplus/browser.py

@@ -25,7 +25,8 @@ import lxml.etree
 from weboob.tools.browser import BaseBrowser
 from weboob.tools.browser.decorators import id2url
 
-from .pages import InitPage, CanalplusVideo, VideoPage
+from .pages import InitPage, VideoPage
+from .video import CanalplusVideo
 
 from weboob.capabilities.collection import Collection, CollectionNotFound
 
@@ -85,9 +86,12 @@ class CanalplusBrowser(BaseBrowser):
             if len(path) == 0 or not isinstance(collections, (list, Collection)):
                 return collections
             i = path[0]
-            if i not in [collection.title for collection in collections]:
-                raise CollectionNotFound()
+            matches = [collection
+                        for collection in collections
+                        if collection.id == i or collection.title == i]
+            if not len(matches):
+                raise CollectionNotFound(path)
 
-            return walk_res(path[1:], [collection.children for collection in collections if collection.title == i][0])
+            return walk_res(path[1:], matches[0])
 
         return walk_res(split_path, collections)

modules/canalplus/pages/__init__.py

@@ -18,7 +18,6 @@
 # along with weboob. If not, see <http://www.gnu.org/licenses/>.
 
 from .initpage import InitPage
-from .video import CanalplusVideo
 from .videopage import VideoPage
 
-__all__ = ['InitPage', 'VideoPage',  'CanalplusVideo']
+__all__ = ['InitPage', 'VideoPage']

modules/canalplus/pages/initpage.py

@@ -26,24 +26,24 @@ __all__ = ['InitPage']
 
 
 class InitPage(BasePage):
-    
     def on_loaded(self):
         self.collections = []
-        
-        def do(id):
-            self.browser.location("http://service.canal-plus.com/video/rest/getMEAs/cplus/" + id)
+
+        def do(_id):
+            self.browser.location("http://service.canal-plus.com/video/rest/getMEAs/cplus/%s" % _id)
             return self.browser.page.iter_channel()
 
-        ### Parse liste des channels
+        # Parse the list of channels
         for elem in self.document[2].getchildren():
-            coll = Collection()
+            children = []
             for e in elem.getchildren():
                 if e.tag == "NOM":
-                    coll.title = e.text.strip().encode('utf-8')
+                    _id = e.text.strip()
                 elif e.tag == "SELECTIONS":
                     for select in e:
-                        sub = Collection(title=select[1].text.strip().encode('utf-8'))
-                        sub.id = select[0].text
-                        sub.children = do
-                        coll.appendchild(sub)
+                        sub = Collection(_id=select[0].text,
+                                title=select[1].text.strip(),
+                                fct=do)
+                        children.append(sub)
+            coll = Collection(_id, children=children)
             self.collections.append(coll)

modules/canalplus/pages/videopage.py

@@ -23,7 +23,7 @@ from datetime import datetime
 from weboob.capabilities.base import NotAvailable
 from weboob.tools.capabilities.thumbnail import Thumbnail
 from weboob.tools.browser import BasePage
-from .video import CanalplusVideo
+from ..video import CanalplusVideo
 
 
 __all__ = ['VideoPage']
@@ -78,7 +78,7 @@ class VideoPage(BasePage):
 
     def iter_channel(self):
         for vid in self.document.getchildren():
-	        yield self.parse_video_channel(vid)
+            yield self.parse_video_channel(vid)
 
     def parse_video_channel(self,el):
         _id = el[0].text