new cap/app lyrics

weboob/capabilities/lyrics.py

@@ -0,0 +1,63 @@
+# -*- coding: utf-8 -*-
+
+# Copyright(C) 2013
+#
+# 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, Field, StringField, FloatField, \
+                  DateField, IntField, UserError
+
+
+__all__ = ['SongLyrics', 'ICapLyrics']
+
+
+class SongLyrics(CapBaseObject):
+    """
+    Song lyrics object.
+    """
+    title =      StringField('Title of the song')
+    artist =       StringField('Artist of the song')
+    content =    StringField('Lyrics of the song')
+
+    def __init__(self, id, title):
+        CapBaseObject.__init__(self, id)
+        self.title = title
+
+
+class ICapLyrics(IBaseCap):
+    """
+    Lyrics websites.
+    """
+    def iter_lyrics(self, pattern):
+        """
+        Search lyrics and iterate on results.
+
+        :param pattern: pattern to search
+        :type pattern: str
+        :rtype: iter[:class:`SongLyrics`]
+        """
+        raise NotImplementedError()
+
+    def get_lyrics(self, _id):
+        """
+        Get a lyrics object from an ID.
+
+        :param _id: ID of lyrics
+        :type _id: str
+        :rtype: :class:`SongLyrics`
+        """
+        raise NotImplementedError()