Source code for

# Copyright(C) 2010-2014 Romain Bignon
# This file is part of woob.
# woob is free software: you can redistribute it and/or modify
# it under the terms of the GNU Lesser General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
# woob is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# GNU Lesser General Public License for more details.
# You should have received a copy of the GNU Lesser General Public License
# along with woob. If not, see <>.

from __future__ import annotations

from typing import Dict

from import Value

from .base import Capability, BaseObject, Field, StringField, UserError
from .date import DateField
from .contact import Contact

__all__ = ['OptimizationNotFound', 'Optimization', 'Event', 'CapDating']

[docs]class OptimizationNotFound(UserError): """ Raised when an optimization is not found. """
[docs]class Optimization(BaseObject): """ Optimization. :var CONFIG: Configuration of optim can be made by :class:`` objects in this dict. """ CONFIG: Dict[str, Value] = {}
[docs] def start(self): """ Start optimization. """ raise NotImplementedError()
[docs] def stop(self): """ Stop optimization. """ raise NotImplementedError()
[docs] def is_running(self): """ Know if the optimization is currently running. :rtype: bool """ raise NotImplementedError()
[docs] def get_config(self): """ Get config of this optimization. :rtype: dict """ return None
[docs] def set_config(self, params): """ Set config of this optimization. :param params: parameters :type params: dict """ raise NotImplementedError()
[docs]class Event(BaseObject): """ A dating event (for example a visite, a query received, etc.) """ date = DateField('Date of event') contact = Field('Contact related to this event', Contact) type = StringField('Type of event') message = StringField('Message of the event')
[docs]class CapDating(Capability): """ Capability for dating websites. """
[docs] def init_optimizations(self): """ Initialization of optimizations. """ raise NotImplementedError()
[docs] def add_optimization(self, name, optim): """ Add an optimization. :param name: name of optimization :type name: str :param optim: optimization :type optim: :class:`Optimization` """ = name setattr(self, 'OPTIM_%s' % name, optim)
[docs] def iter_optimizations(self): """ Iter optimizations. :rtype: iter[:class:`Optimization`] """ for attr_name in dir(self): if not attr_name.startswith('OPTIM_'): continue attr = getattr(self, attr_name) if attr is None: continue yield attr
[docs] def get_optimization(self, optim): """ Get an optimization from a name. :param optim: name of optimization :type optim: str :rtype: :class:`Optimization` """ optim = optim.upper() if not hasattr(self, 'OPTIM_%s' % optim): raise OptimizationNotFound() return getattr(self, 'OPTIM_%s' % optim)
[docs] def iter_events(self): """ Iter events. :rtype: iter[:class:`Event`] """ raise NotImplementedError()
[docs] def iter_new_contacts(self): """ Iter new contacts. :rtype: iter[:class:`Contact`] """ raise NotImplementedError()