woob.capabilities.calendar

class woob.capabilities.calendar.BaseCalendarEvent(id='', url=NotLoaded, backend=None)

Bases: woob.capabilities.base.BaseObject

Represents a calendar event

Variables

  • start_date – (date, datetime) Start date of the event

  • end_date – (date, datetime) End date of the event

  • timezone – (str) Timezone of the event in order to convert to utc time (default: Etc/UCT)

  • summary – (str) Title of the event

  • address – (PostalAddress) Address where event will take place

  • category – (str) Category of the event

  • description – (str) Description of the event

  • price – (float) Price of the event

  • booked_entries – (int, int) Entry number

  • max_entries – (int, int) Max entry number

  • event_planner – (str) Name of the event planner

  • sequence – (int, int) Number of updates, the first is number 1

  • status – (str) Status of the event

  • transp – (str) Describes if event is available

  • ticket – (str) Describes if tickets are available

property city
classmethod id2url(_id)

Overloaded in child classes provided by backends.

property location
property page_url

Get page URL of the announce.

class woob.capabilities.calendar.CapCalendarEvent

Bases: woob.capabilities.collection.CapCollection

Capability of calendar event type sites

ASSOCIATED_CATEGORIES = 'ALL'
attends_event(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

get_event(_id)

Get an event from an ID.

Parameters

_id (str) – id of the event

Return type

BaseCalendarEvent or None is fot found.

has_matching_categories(query)
iter_resources(objs, split_path)

Iter events by category

list_events(date_from, date_to=None)

list coming event.

Parameters

  • date_from (date) – date of beguinning of the events list

  • date_to (date) – date of ending of the events list

Return type

iter[BaseCalendarEvent]

search_events(query)

Search event

Parameters

query (Query) – search query

Return type

iter[BaseCalendarEvent]

validate_collection(objs, collection)

Validate Collection