weboob-devel/weboob/capabilities/radio.py
Laurent Bachelier 7094931c92 Easy spacing fixes, trailing stuff
Remove useless trailing \
Remove trailing spaces
Add missing empty lines

autopep8 -ir -j2 --select=E301,E302,E502,W291,W293,W391 .

Diff quickly checked.
2013-03-16 00:54:55 +01:00

91 lines
2.4 KiB
Python

# -*- coding: utf-8 -*-
# Copyright(C) 2010-2011 Romain Bignon
#
# 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
__all__ = ['Emission', 'Stream', 'Radio', 'ICapRadio']
class Emission(CapBaseObject):
"""
Emission of a radio.
"""
artist = StringField('Name of artist')
title = StringField('Title of song or emission')
def __iscomplete__(self):
# This volatile information may be reloaded everytimes.
return False
def __unicode__(self):
if self.artist:
return u'%s - %s' % (self.artist, self.title)
else:
return self.title
class Stream(CapBaseObject):
"""
Stream of a radio.
"""
title = StringField('Title of stream')
url = StringField('Direct URL to the stream')
def __unicode__(self):
return u'%s (%s)' % (self.title, self.url)
def __repr__(self):
return self.__unicode__()
class Radio(CapBaseObject):
"""
Radio object.
"""
title = StringField('Title of radio')
description = StringField('Description of radio')
current = Field('Current emission', Emission)
streams = Field('List of streams', list)
class ICapRadio(IBaseCap):
"""
Capability of radio websites.
"""
def iter_radios_search(self, pattern):
"""
Search a radio.
:param pattern: pattern to search
:type pattern: str
:rtype: iter[:class:`Radio`]
"""
raise NotImplementedError()
def get_radio(self, id):
"""
Get a radio from an ID.
:param id: ID of radio
:type id: str
:rtype: :class:`Radio`
"""
raise NotImplementedError()