File: __init__.py

package info (click to toggle)
python-febelfin-coda 0.3.0-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 212 kB
  • sloc: python: 680; sh: 9; makefile: 3
file content (489 lines) | stat: -rw-r--r-- 15,654 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
# This file is part of febelfin-coda.  The COPYRIGHT file at the top level of
# this repository contains the full copyright notices and license terms.
"""a parser for CODA files
"""
import io
from collections import defaultdict
from datetime import datetime
from decimal import Decimal

__version__ = '0.3.0'
__all__ = ['CODA', 'Statement', 'Move', 'Information', 'FreeCommunication']


class CODA(object):

    def __init__(self, name, encoding='windows-1252'):
        self.statements = []

        if isinstance(name, (bytes, str)):
            with io.open(name, encoding=encoding, mode='r') as f:
                self._parse(f)
        else:
            self._parse(name)

    def _parse(self, f):
        statement = None
        total_credit, total_debit = 0, 0
        move = None
        information = None
        i = 0
        for record in f:
            type_ = record[0]
            if type_ == '0':
                statement = Statement()
                self.statements.append(statement)
                self._parse_statement(record, statement, HEADER)

                if statement.version != 2:
                    raise ValueError(
                        "Unsupported version %d" % statement.version)
            elif type_ == '1':
                self._parse_statement(record, statement, OLD_BALANCE)
                i += 1
            elif type_ == '2':
                article = record[1]
                if article == '1':
                    move = Move()
                self._parse_move(record, article, move)
                if article == '1':
                    transaction_type = move.transaction_type
                    if transaction_type in {'0', '1', '2', '3'}:
                        statement.moves.append(move)

                        if move.amount > 0:
                            total_credit += move.amount
                        else:
                            total_debit -= move.amount
                    elif transaction_type in {'5', '6', '7', '8'}:
                        parent = statement.moves[-1]
                        assert parent.sequence == move.sequence
                        parent.moves.append(move)
                    elif transaction_type == '9':
                        parent = statement.moves[-1].moves[-1]
                        assert parent.sequence == move.sequence
                        parent.append(move)
                    else:
                        raise ValueError('Unknown type: %s' % transaction_type)
                i += 1
            elif type_ == '3':
                article = record[1]
                if article == '1':
                    information = Information()
                self._parse_information(record, article, information)
                if article == '1':
                    key = information.bank_reference
                    statement.informations[key].append(information)
                i += 1
            elif type_ == '4':
                free_communication = FreeCommunication()
                self._parse_free_communication(record, free_communication)
                statement.free_communications.append(free_communication)
            elif type_ == '8':
                self._parse_statement(record, statement, NEW_BALANCE)
                i += 1
            elif type_ == '9':
                self._parse_statement(record, statement, TRAILER)

                assert (statement.new_balance - statement.old_balance
                    == statement.total_credit - statement.total_debit)
                assert statement.total_credit == total_credit
                assert statement.total_debit == total_debit
                assert statement.number_records == i
                statement = None
                total_credit, total_debit = 0, 0
                i = 0

    def _parse_statement(self, record, statement, desc):
        for name, (slice_, parser) in desc.items():
            value = parser(record[slice_])
            if getattr(statement, name) is not None:
                assert getattr(statement, name) == value, (name, value,
                    getattr(statement, name), statement)
            setattr(statement, name, value)

    def _parse_move(self, record, article, move):
        for name, (slice_, parser) in MOVE_COMMON.items():
            value = parser(record[slice_])
            if getattr(move, name) is not None:
                assert getattr(move, name) == value
            else:
                setattr(move, name, value)
        for name, (slice_, parser) in MOVE[article].items():
            value = parser(record[slice_])
            if getattr(move, name):
                value = getattr(move, name) + value
            setattr(move, name, value)

    def _parse_information(self, record, article, information):
        for name, (slice_, parser) in INFORMATION_COMMON.items():
            value = parser(record[slice_])
            if getattr(information, name) is not None:
                assert getattr(information, name) == value
            else:
                setattr(information, name, value)
        for name, (slice_, parser) in INFORMATION[article].items():
            value = parser(record[slice_])
            if getattr(information, name):
                value = getattr(information, name) + value
            setattr(information, name, value)

    def _parse_free_communication(self, record, free_communication):
        for name, (slice_, parser) in FREE_COMMUNICATION.items():
            value = parser(record[slice_])
            setattr(free_communication, name, value)


def _date(value):
    return datetime.strptime(value, '%d%m%y').date()


def _string(value):
    return value.rstrip()


def _amount(value):
    sign = value[0:1]
    amount = Decimal(value[1:])
    if sign == '1':
        amount *= -1
    return amount / 1000


HEADER = {
    'creation_date': (slice(5, 11), _date),
    'bank_id': (slice(11, 14), int),
    'duplicate': (slice(16, 17), lambda c: c == 'D'),
    'file_reference': (slice(24, 34), _string),
    'address': (slice(34, 60), _string),
    'bic': (slice(60, 71), _string),
    'company_id': (slice(71, 82), str),
    'reference': (slice(88, 104), _string),
    'related_reference': (slice(105, 120), _string),
    'version': (slice(127, 128), int),
    }
TRAILER = {
    'number_records': (slice(16, 22), int),
    'total_debit': (slice(22, 37), _amount),
    'total_credit': (slice(37, 52), _amount),
    }
OLD_BALANCE = {
    '_account_structure': (slice(1, 2), str),
    'old_sequence': (slice(2, 5), str),
    '_account_currency': (slice(5, 42), str),
    'old_balance': (slice(42, 58), _amount),
    'old_balance_date': (slice(58, 64), _date),
    'account_holder_name': (slice(64, 90), _string),
    'account_description': (slice(90, 125), _string),
    'coda_sequence': (slice(125, 128), str),
    }
NEW_BALANCE = {
    'new_sequence': (slice(1, 4), str),
    '_account_currency': (slice(4, 41), str),
    'new_balance': (slice(41, 57), _amount),
    'new_balance_date': (slice(57, 63), _date),
    }


class _SlotsNone(object):
    def __init__(self, *args, **kwargs):
        super(_SlotsNone, self).__init__(*args, **kwargs)
        for name in self.__slots__:
            setattr(self, name, None)


class _Moves(object):
    __slots__ = ('moves',)

    def __init__(self, *args, **kwargs):
        super(_Moves, self).__init__(*args, **kwargs)
        self.moves = []

    def find_move(self, sequence, detail_sequence='0000'):
        for move in self.moves:
            if move.sequence == sequence:
                if move.detail_sequence == detail_sequence:
                    return move
                found = move.find_move(sequence, detail_sequence)
                if found:
                    return found

    @property
    def all_moves(self):
        for move in self.moves:
            yield move
            for move in move.all_moves:
                yield move


class Statement(_SlotsNone, _Moves):
    __slots__ = (list(HEADER.keys()) + list(TRAILER.keys())
        + list(OLD_BALANCE.keys()) + list(NEW_BALANCE.keys())
        + ['informations', 'free_communications'])

    def __init__(self, *args, **kwargs):
        super(Statement, self).__init__(*args, **kwargs)
        self.informations = defaultdict(list)
        self.free_communications = []

    def __str__(self):
        if self.old_sequence != self.new_sequence:
            return ' - '.join([self.old_sequence, self.new_sequence])
        else:
            return self.old_sequence

    @property
    def account(self):
        return _string(self._account_currency[{
            '0': slice(0, 12),
            '1': slice(0, 34),
            '2': slice(0, 31),
            '3': slice(0, 34),
            }[self._account_structure]])

    @property
    def account_currency(self):
        return self._account_currency[{
                '0': slice(13, 16),
                '1': slice(34, 37),
                '2': slice(34, 37),
                '3': slice(34, 37),
                }[self._account_structure]]

    @property
    def account_country(self):
        if self._account_structure == '0':
            return self._account_currency[17:19]


class _TransactionMixin(object):

    @property
    def transaction_type(self):
        return self.transaction_code[0]

    @property
    def transaction_family(self):
        return self.transaction_code[1:3]

    @property
    def transaction_transaction(self):
        return self.transaction_code[3:5]

    @property
    def transaction_category(self):
        return self.transaction_code[5:8]


MOVE_COMMON = {
    'sequence': (slice(2, 6), str),
    'detail_sequence': (slice(6, 10), str),
    }
MOVE = {
    '1': {
        'bank_reference': (slice(10, 31), str),
        'amount': (slice(31, 47), _amount),
        'value_date': (slice(47, 53), _date),
        'transaction_code': (slice(53, 61), str),
        '_communication': (slice(61, 115), str),
        'entry_date': (slice(115, 121), _date),
        'statement_number': (slice(121, 124), str),
        },
    '2': {
        '_communication': (slice(10, 63), str),
        'customer_reference': (slice(63, 98), _string),
        'counterparty_bic': (slice(98, 109), _string),
        'r_transaction': (slice(112, 113), _string),
        'r_reason': (slice(113, 117), _string),
        'category_purpose': (slice(117, 121), _string),
        'purpose': (slice(121, 125), _string),
        },
    '3': {
        'counterparty_account': (slice(10, 47), _string),
        'counterparty_name': (slice(47, 82), _string),
        '_communication': (slice(82, 125), str),
        },
    }


class Move(_SlotsNone, _Moves, _TransactionMixin):
    __slots__ = sum(
        (list(m.keys()) for m in MOVE.values()), list(MOVE_COMMON.keys()))

    def __str__(self):
        return self.sequence + self.detail_sequence

    @property
    def communication(self):
        type_ = self.communication_type
        if type_ is None:
            return _string(self._communication[1:])
        elif type_ == '100':
            # TODO ISO-11649
            return self._communication[4:]
        elif type_ in {'101', '102', '103'}:
            return _string(self._communication[4:16])
        elif type_ == '105':
            return _string(self._communication[49:61])
        elif type_ in {'106', '108', '111', '113', '114', '115',
                '121', '122', '123', '124', '125', '126'}:
            return
        elif type_ == '127':
            return self._communication[83:145]
        else:
            return self._communication[2:]
    # TODO add parser communication

    @property
    def communication_type(self):
        type_ = self._communication[0]
        if type_ == '1':
            return self._communication[1:4]


INFORMATION_COMMON = {
    'sequence': (slice(2, 6), str),
    'detail_sequence': (slice(6, 10), str),
    }
INFORMATION = {
    '1': {
        'bank_reference': (slice(10, 31), str),
        'transaction_code': (slice(31, 39), str),
        '_communication': (slice(39, 113), str),
        },
    '2': {
        '_communication': (slice(10, 115), str),
        },
    '3': {
        '_communication': (slice(10, 100), str),
        },
    }


class Information(_SlotsNone, _TransactionMixin):
    __slots__ = sum(
        (list(m.keys()) for m in INFORMATION.values()),
        list(INFORMATION_COMMON.keys()))

    def __str__(self):
        return self.sequence + self.detail_sequence

    @property
    def communication_type(self):
        type_ = self._communication[0]
        if type_ == '1':
            return self._communication[1:4]

    @property
    def name(self):
        if self.communication_type in {'001', '008', '009'}:
            return _string(self._communication[4:74])
        else:
            raise AttributeError

    @property
    def street(self):
        if self.communication_type == '001':
            return _string(self._communication[74:109])
        else:
            raise AttributeError

    @property
    def locality(self):
        if self.communication_type == '001':
            return _string(self._communication[109:144])
        else:
            raise AttributeError

    @property
    def code_id(self):
        if self.communication_type == '001':
            return _string(self._communication[144:179])
        elif self.communication_type in {'008', '009'}:
            return _string(self._communication[74:109])
        else:
            raise AttributeError

    @property
    def communication(self):
        if self.communication_type == '002':
            return self._communication[4:]
        else:
            raise AttributeError

    @property
    def counterparty_banker(self):
        if self.communication_type == '004':
            return _string(self._communication[4:])
        else:
            raise AttributeError

    @property
    def correspondent_data(self):
        if self.communication_type == '005':
            return self._communication[4:]
        else:
            raise AttributeError

    @property
    def description(self):
        if self.communication_type == '006':
            return self._communication[4:34]
        else:
            raise AttributeError

    @property
    def currency(self):
        if self.communication_type == '006':
            return self._communication[34:37]
        else:
            raise AttributeError

    @property
    def amount(self):
        if self.communication_type == '006':
            return _amount(
                self._communication[53] + self._communication[37:52])
        else:
            raise AttributeError

    @property
    def category(self):
        if self.communication_type == '006':
            return self._communication[53:56]
        else:
            raise AttributeError

    @property
    def coin_number(self):
        if self.communication_type == '007':
            return int(self._communication[4:11])
        else:
            raise AttributeError

    @property
    def coin(self):
        if self.communication_type == '007':
            return Decimal(self._communication[11:17]) / 1000
        else:
            raise AttributeError

    @property
    def total_amount(self):
        if self.communication_type == '007':
            return Decimal(self._communication[17:32]) / 1000
        else:
            raise AttributeError

    # TODO communication type: 010 and 011


FREE_COMMUNICATION = {
    'sequence': (slice(2, 6), str),
    'detail_sequence': (slice(6, 10), str),
    'text': (slice(32, 112), _string),
    }


class FreeCommunication(_SlotsNone):
    __slots__ = list(FREE_COMMUNICATION.keys())