419cce14fc
* define price as float * add comments * add new parameters (entry, max_entry, event_planner) * add new method attends_event
111 lines
3.6 KiB
Python
111 lines
3.6 KiB
Python
# -*- coding: utf-8 -*-
|
|
|
|
# Copyright(C) 2010-2013 Bezleputh
|
|
#
|
|
# 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 CapBaseObject, IBaseCap, StringField, DateField, IntField, FloatField
|
|
|
|
__all__ = ['BaseCalendarEvent', 'ICapCalendarEvent']
|
|
|
|
|
|
def enum(**enums):
|
|
return type('Enum', (), enums)
|
|
|
|
CATEGORIES = enum(CINE='Cinema', CONCERT='Concert', THEATRE='Theatre')
|
|
|
|
#the following elements deal with ICalendar stantdards
|
|
#see http://fr.wikipedia.org/wiki/ICalendar#Ev.C3.A9nements_.28VEVENT.29
|
|
TRANSP = enum(OPAQUE='OPAQUE', TRANSPARENT='TRANSPARENT')
|
|
STATUS = enum(TENTATIVE='TENTATIVE', CONFIRMED='CONFIRMED', CANCELLED='CANCELLED')
|
|
|
|
|
|
class BaseCalendarEvent(CapBaseObject):
|
|
"""
|
|
Represents a calendar event
|
|
"""
|
|
|
|
url = StringField('URL of the event')
|
|
start_date = DateField('Start date of the event')
|
|
end_date = DateField('End date of the event')
|
|
summary = StringField('Title of the event')
|
|
location = StringField('Location of the event')
|
|
category = StringField('Category of the event')
|
|
description = StringField('Description of the event')
|
|
price = FloatField('Price of the event')
|
|
entry = IntField('Entry number')
|
|
max_entry = IntField('Max entry number')
|
|
event_planner = StringField('Name of the event planner')
|
|
|
|
#the following elements deal with ICalendar stantdards
|
|
#see http://fr.wikipedia.org/wiki/ICalendar#Ev.C3.A9nements_.28VEVENT.29
|
|
sequence = IntField('Number of updates, the first is number 1')
|
|
|
|
# (TENTATIVE, CONFIRMED, CANCELLED)
|
|
status = StringField('Status of theevent')
|
|
# (OPAQUE, TRANSPARENT)
|
|
transp = StringField('Describes if event is available')
|
|
|
|
@classmethod
|
|
def id2url(cls, _id):
|
|
"""Overloaded in child classes provided by backends."""
|
|
raise NotImplementedError()
|
|
|
|
@property
|
|
def page_url(self):
|
|
"""
|
|
Get page URL of the announce.
|
|
"""
|
|
return self.id2url(self.id)
|
|
|
|
|
|
class ICapCalendarEvent(IBaseCap):
|
|
"""
|
|
Capability of calendar event type sites
|
|
"""
|
|
|
|
def list_events(self, date_from, date_to=None):
|
|
"""
|
|
list coming event.
|
|
|
|
:param date_from: date of beguinning of the events list
|
|
:type date_from: date
|
|
:param date_to: date of ending of the events list
|
|
:type date_to: date
|
|
:rtype: iter[:class:`BaseCalendarEvent`]
|
|
"""
|
|
raise NotImplementedError()
|
|
|
|
def get_event(self, _id, event=None):
|
|
"""
|
|
Get an event from an ID.
|
|
|
|
:param _id: id of the event
|
|
:type _id: str
|
|
:param event : the event
|
|
:type event : BaseCalendarEvent
|
|
:rtype: :class:`BaseCalendarEvent` or None is fot found.
|
|
"""
|
|
raise NotImplementedError()
|
|
|
|
def attends_event(self, event, is_attending=True):
|
|
"""
|
|
Attends or not to an event
|
|
:param event : the event
|
|
:type event : BaseCalendarEvent
|
|
:param is_attending : is attending to the event or not
|
|
:type is_attending : bool
|
|
"""
|