7094931c92
Remove useless trailing \ Remove trailing spaces Add missing empty lines autopep8 -ir -j2 --select=E301,E302,E502,W291,W293,W391 . Diff quickly checked.
252 lines
7.4 KiB
Python
252 lines
7.4 KiB
Python
# -*- coding: utf-8 -*-
|
|
|
|
# Copyright(C) 2010-2012 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/>.
|
|
|
|
|
|
import re
|
|
from datetime import date, datetime
|
|
|
|
from .base import CapBaseObject, Field, StringField, DateField, DecimalField, IntField, UserError
|
|
from .collection import ICapCollection
|
|
|
|
|
|
__all__ = ['AccountNotFound', 'TransferError', 'Recipient', 'Account', 'Transaction', 'Transfer', 'ICapBank']
|
|
|
|
|
|
class AccountNotFound(UserError):
|
|
"""
|
|
Raised when an account is not found.
|
|
"""
|
|
|
|
def __init__(self, msg='Account not found'):
|
|
UserError.__init__(self, msg)
|
|
|
|
|
|
class TransferError(UserError):
|
|
"""
|
|
A transfer has failed.
|
|
"""
|
|
|
|
|
|
class Currency(object):
|
|
CUR_UNKNOWN = 0
|
|
CUR_EUR = 1
|
|
CUR_CHF = 2
|
|
CUR_USD = 3
|
|
|
|
TXT2CUR = {u'€': CUR_EUR,
|
|
u'EUR': CUR_EUR,
|
|
u'CHF': CUR_CHF,
|
|
u'$': CUR_USD,
|
|
u'USD': CUR_USD,
|
|
}
|
|
|
|
EXTRACTOR = re.compile(r'[\d\s,\.\-]', re.UNICODE)
|
|
|
|
@classmethod
|
|
def get_currency(klass, text):
|
|
u"""
|
|
>>> Currency.get_currency(u'42')
|
|
0
|
|
>>> Currency.get_currency(u'42 €')
|
|
1
|
|
>>> Currency.get_currency(u'$42')
|
|
3
|
|
>>> Currency.get_currency(u'42.000,00€')
|
|
1
|
|
>>> Currency.get_currency(u'$42 USD')
|
|
3
|
|
>>> Currency.get_currency(u'%42 USD')
|
|
3
|
|
>>> Currency.get_currency(u'US1D')
|
|
0
|
|
"""
|
|
curtexts = klass.EXTRACTOR.sub(' ', text.upper()).split()
|
|
for curtext in curtexts:
|
|
cur = klass.TXT2CUR.get(curtext)
|
|
if cur is not None:
|
|
return cur
|
|
return klass.CUR_UNKNOWN
|
|
|
|
|
|
class Recipient(CapBaseObject):
|
|
"""
|
|
Recipient of a transfer.
|
|
"""
|
|
|
|
label = StringField('Name')
|
|
|
|
def __init__(self):
|
|
CapBaseObject.__init__(self, 0)
|
|
|
|
|
|
class Account(Recipient, Currency):
|
|
"""
|
|
Bank account.
|
|
|
|
It is a child class of :class:`Recipient`, because an account can be
|
|
a recipient of a transfer.
|
|
"""
|
|
TYPE_UNKNOWN = 0
|
|
TYPE_CHECKING = 1 # Transaction, everyday transactions
|
|
TYPE_SAVINGS = 2 # Savings/Deposit, can be used for everyday banking
|
|
TYPE_DEPOSIT = 3 # Term or Fixed Deposit, has time/amount constraints
|
|
TYPE_LOAN = 4
|
|
TYPE_MARKET = 5 # Stock market or other variable investments
|
|
TYPE_JOINT = 6 # Joint account
|
|
|
|
type = IntField('Type of account', default=TYPE_UNKNOWN)
|
|
balance = DecimalField('Balance on this bank account')
|
|
coming = DecimalField('Coming balance')
|
|
currency = IntField('Currency', default=Currency.CUR_UNKNOWN)
|
|
|
|
def __repr__(self):
|
|
return u"<Account id=%r label=%r>" % (self.id, self.label)
|
|
|
|
|
|
class Transaction(CapBaseObject):
|
|
"""
|
|
Bank transaction.
|
|
"""
|
|
TYPE_UNKNOWN = 0
|
|
TYPE_TRANSFER = 1
|
|
TYPE_ORDER = 2
|
|
TYPE_CHECK = 3
|
|
TYPE_DEPOSIT = 4
|
|
TYPE_PAYBACK = 5
|
|
TYPE_WITHDRAWAL = 6
|
|
TYPE_CARD = 7
|
|
TYPE_LOAN_PAYMENT = 8
|
|
TYPE_BANK = 9
|
|
|
|
date = DateField('Debit date')
|
|
rdate = DateField('Real date, when the payment has been made')
|
|
type = IntField('Type of transaction, use TYPE_* constants', default=TYPE_UNKNOWN)
|
|
raw = StringField('Raw label of the transaction')
|
|
category = StringField('Category of transaction')
|
|
label = StringField('Pretty label')
|
|
amount = DecimalField('Amount of transaction')
|
|
|
|
def __repr__(self):
|
|
label = self.label.encode('utf-8') if self.label else self.label
|
|
return "<Transaction date='%s' label='%s' amount=%s>" % (self.date,
|
|
label, self.amount)
|
|
|
|
|
|
class Transfer(CapBaseObject):
|
|
"""
|
|
Transfer from an account to a recipient.
|
|
"""
|
|
|
|
amount = DecimalField('Amount to transfer')
|
|
date = Field('Date of transfer', basestring, date, datetime)
|
|
origin = Field('Origin of transfer', int, long, basestring)
|
|
recipient = Field('Recipient', int, long, basestring)
|
|
reason = StringField('Reason')
|
|
|
|
|
|
class ICapBank(ICapCollection):
|
|
"""
|
|
Capability of bank websites to see accounts and transactions.
|
|
"""
|
|
def iter_resources(self, objs, split_path):
|
|
"""
|
|
Iter resources.
|
|
|
|
Default implementation of this method is to return on top-level
|
|
all accounts (by calling :func:`iter_accounts`).
|
|
|
|
:param objs: type of objects to get
|
|
:type objs: tuple[:class:`CapBaseObject`]
|
|
:param split_path: path to discover
|
|
:type split_path: :class:`list`
|
|
:rtype: iter[:class:`BaseCapObject`]
|
|
"""
|
|
if Account in objs:
|
|
self._restrict_level(split_path)
|
|
|
|
return self.iter_accounts()
|
|
|
|
def iter_accounts(self):
|
|
"""
|
|
Iter accounts.
|
|
|
|
:rtype: iter[:class:`Account`]
|
|
"""
|
|
raise NotImplementedError()
|
|
|
|
def get_account(self, id):
|
|
"""
|
|
Get an account from its ID.
|
|
|
|
:param id: ID of the account
|
|
:type id: :class:`str`
|
|
:rtype: :class:`Account`
|
|
:raises: :class:`AccountNotFound`
|
|
"""
|
|
raise NotImplementedError()
|
|
|
|
def iter_history(self, account):
|
|
"""
|
|
Iter history of transactions on a specific account.
|
|
|
|
:param account: account to get history
|
|
:type account: :class:`Account`
|
|
:rtype: iter[:class:`Transaction`]
|
|
:raises: :class:`AccountNotFound`
|
|
"""
|
|
raise NotImplementedError()
|
|
|
|
def iter_coming(self, account):
|
|
"""
|
|
Iter coming transactions on a specific account.
|
|
|
|
:param account: account to get coming transactions
|
|
:type account: :class:`Account`
|
|
:rtype: iter[:class:`Transaction`]
|
|
:raises: :class:`AccountNotFound`
|
|
"""
|
|
raise NotImplementedError()
|
|
|
|
def iter_transfer_recipients(self, account):
|
|
"""
|
|
Iter recipients availables for a transfer from a specific account.
|
|
|
|
:param account: account which initiate the transfer
|
|
:type account: :class:`Account`
|
|
:rtype: iter[:class:`Recipient`]
|
|
:raises: :class:`AccountNotFound`
|
|
"""
|
|
raise NotImplementedError()
|
|
|
|
def transfer(self, account, recipient, amount, reason=None):
|
|
"""
|
|
Make a transfer from an account to a recipient.
|
|
|
|
:param account: account to take money
|
|
:type account: :class:`Account`
|
|
:param recipient: account to send money
|
|
:type recipient: :class:`Recipient`
|
|
:param amount: amount
|
|
:type amount: :class:`decimal.Decimal`
|
|
:param reason: reason of transfer
|
|
:type reason: :class:`unicode`
|
|
:rtype: :class:`Transfer`
|
|
:raises: :class:`AccountNotFound`, :class:`TransferError`
|
|
"""
|
|
raise NotImplementedError()
|