682e14c86a
* Make the declaration of fct and it in the constructor Collection, instead of adding them from the outside * Add a function to flatten a list containing collection (solves the radioob search crash) * Better display of collections in the "ls" command (and display both id and title) * The "cd" command goes to the root of the path (like the UNIX cd) * Move the Video object of canalplus in a correct path * Make Collection iterable * Add comments to CapCollection * Cache the result of fct in a Collection; it is only called once * CollectionNotFound errors can be more explicit by providing a path * Require utf-8 in collection paths * Code cleanups
114 lines
3.5 KiB
Python
114 lines
3.5 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 datetime import datetime, date
|
|
|
|
from .base import CapBaseObject
|
|
from .collection import ICapCollection, CollectionNotFound
|
|
|
|
|
|
__all__ = ['Account', 'AccountNotFound', 'TransferError', 'ICapBank',
|
|
'Operation']
|
|
|
|
|
|
class AccountNotFound(Exception):
|
|
def __init__(self, msg=None):
|
|
if msg is None:
|
|
msg = 'Account not found'
|
|
Exception.__init__(self, msg)
|
|
|
|
class TransferError(Exception):
|
|
pass
|
|
|
|
class Recipient(CapBaseObject):
|
|
def __init__(self):
|
|
CapBaseObject.__init__(self, 0)
|
|
self.add_field('label', basestring)
|
|
|
|
class Account(Recipient):
|
|
def __init__(self):
|
|
Recipient.__init__(self)
|
|
self.add_field('balance', float)
|
|
self.add_field('coming', float)
|
|
self.link_id = None
|
|
|
|
def __repr__(self):
|
|
return u"<Account id=%r label=%r>" % (self.id, self.label)
|
|
|
|
|
|
class Operation(CapBaseObject):
|
|
def __init__(self, id):
|
|
CapBaseObject.__init__(self, id)
|
|
self.add_field('date', (basestring, datetime, date))
|
|
self.add_field('category', unicode)
|
|
self.add_field('label', unicode)
|
|
self.add_field('amount', float)
|
|
|
|
def __repr__(self):
|
|
return "<Operation date='%s' label='%s' amount=%s>" % (self.date,
|
|
self.label, self.amount)
|
|
|
|
class Transfer(CapBaseObject):
|
|
def __init__(self, id):
|
|
CapBaseObject.__init__(self, id)
|
|
self.add_field('amount', float)
|
|
self.add_field('date', (basestring, datetime, date))
|
|
self.add_field('origin', (int, long, basestring))
|
|
self.add_field('recipient', (int, long, basestring))
|
|
|
|
class ICapBank(ICapCollection):
|
|
def iter_resources(self, split_path):
|
|
if len(split_path) > 0:
|
|
raise CollectionNotFound(split_path)
|
|
|
|
return self.iter_accounts()
|
|
|
|
def iter_accounts(self):
|
|
raise NotImplementedError()
|
|
|
|
def get_account(self, _id):
|
|
raise NotImplementedError()
|
|
|
|
def iter_operations(self, account):
|
|
raise NotImplementedError()
|
|
|
|
def iter_history(self, account):
|
|
raise NotImplementedError()
|
|
|
|
def iter_transfer_recipients(self, account):
|
|
"""
|
|
Iter recipients availables for a transfer from a specific account.
|
|
|
|
@param account [Account] account which initiate the transfer
|
|
@return [iter(Recipient)]
|
|
"""
|
|
raise NotImplementedError()
|
|
|
|
def transfer(self, account, recipient, amount, reason=None):
|
|
"""
|
|
Make a transfer from an account to a recipient.
|
|
|
|
@param account [Account] account to take money
|
|
@param recipient [Recipient] account to send money
|
|
@param amount [float] amount
|
|
@param reason [str] reason of transfer
|
|
@return [Transfer] a Transfer object
|
|
"""
|
|
raise NotImplementedError()
|