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 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507
|
import re
import decimal
import datetime
# python 3.8+ compatibility
try: # pragma: no cover
from collections import abc
except ImportError: # pragma: no cover
import collections as abc
import mt940
from . import _compat
from . import processors
class Model(object):
def __repr__(self):
return '<%s>' % self.__class__.__name__
class FixedOffset(datetime.tzinfo):
'''Fixed time offset based on the Python docs
Source: https://docs.python.org/2/library/datetime.html#tzinfo-objects
>>> offset = FixedOffset(60)
>>> offset.utcoffset(None).total_seconds()
3600.0
>>> offset.dst(None)
datetime.timedelta(0)
>>> offset.tzname(None)
'60'
'''
def __init__(self, offset=0, name=None):
self._name = name or str(offset)
if not isinstance(offset, int):
offset = int(offset)
self._offset = datetime.timedelta(minutes=offset)
def utcoffset(self, dt):
return self._offset
def dst(self, dt):
return datetime.timedelta(0)
def tzname(self, dt):
return self._name
class DateTime(datetime.datetime, Model):
'''Just a regular datetime object which supports dates given as strings
>>> DateTime(year='2000', month='1', day='2', hour='3', minute='4',
... second='5', microsecond='6')
DateTime(2000, 1, 2, 3, 4, 5, 6)
>>> DateTime(year='123', month='1', day='2', hour='3', minute='4',
... second='5', microsecond='6')
DateTime(2123, 1, 2, 3, 4, 5, 6)
>>> DateTime(2000, 1, 2, 3, 4, 5, 6)
DateTime(2000, 1, 2, 3, 4, 5, 6)
>>> DateTime(year='123', month='1', day='2', hour='3', minute='4',
... second='5', microsecond='6', tzinfo=FixedOffset('60'))
DateTime(2123, 1, 2, 3, 4, 5, 6, tzinfo=<mt940.models.FixedOffset ...>)
Args:
year (str): Year (0-100), will automatically add 2000 when needed
month (str): Month
day (str): Day
hour (str): Hour
minute (str): Minute
second (str): Second
microsecond (str): Microsecond
tzinfo (tzinfo): Timezone information. Overwrites `offset`
offset (str): Timezone offset in minutes, generates a tzinfo object
with the given offset if no tzinfo is available.
'''
def __new__(cls, *args, **kwargs):
if kwargs:
values = dict(
year=None,
month=None,
day=None,
hour='0',
minute='0',
second='0',
microsecond='0', )
# The list makes sure this works in both Python 2 and 3
for key, default in list(values.items()):
# Fetch the value or the default
value = kwargs.get(key, default)
assert value is not None, '%s should not be None' % key
# Convert the value to integer and force base 10 to make sure
# it doesn't get recognized as octal
if not isinstance(value, int):
value = int(value, 10)
# Save the values again
values[key] = value
if values['year'] < 1000:
values['year'] += 2000
values['tzinfo'] = None
if kwargs.get('tzinfo'):
values['tzinfo'] = kwargs['tzinfo']
if kwargs.get('offset'):
values['tzinfo'] = FixedOffset(kwargs['offset'])
return datetime.datetime.__new__(cls, **values)
else:
return datetime.datetime.__new__(cls, *args, **kwargs)
class Date(datetime.date, Model):
'''Just a regular date object which supports dates given as strings
>>> Date(year='2000', month='1', day='2')
Date(2000, 1, 2)
>>> Date(year='123', month='1', day='2')
Date(2123, 1, 2)
Args:
year (str): Year (0-100), will automatically add 2000 when needed
month (str): Month
day (str): Day
'''
def __new__(cls, *args, **kwargs):
if kwargs:
dt = DateTime(*args, **kwargs).date()
return datetime.date.__new__(cls, dt.year, dt.month, dt.day)
else:
return datetime.date.__new__(cls, *args, **kwargs)
class Amount(Model):
'''Amount object containing currency and amount
Args:
amount (str): Amount using either a , or a . as decimal separator
status (str): Either C or D for credit or debit respectively
currency (str): A 3 letter currency (e.g. EUR)
>>> Amount('123.45', 'C', 'EUR')
<123.45 EUR>
>>> Amount('123.45', 'D', 'EUR')
<-123.45 EUR>
'''
def __init__(self, amount, status, currency=None, **kwargs):
self.amount = decimal.Decimal(amount.replace(',', '.'))
self.currency = currency
# C = credit, D = debit
if status == 'D':
self.amount = -self.amount
def __eq__(self, other):
return self.amount == other.amount and self.currency == other.currency
def __str__(self):
return '%s %s' % (self.amount, self.currency)
def __repr__(self):
return '<%s>' % self
class SumAmount(Amount):
def __init__(self, *args, **kwargs):
number = kwargs.pop('number')
super(SumAmount, self).__init__(*args, **kwargs)
self.number = number
def __repr__(self):
return '<%s %s in %s stmts)>' % (self.amount, self.currency,
self.number)
class Balance(Model):
'''Parse balance statement
Args:
status (str): Either C or D for credit or debit respectively
amount (Amount): Object containing the amount and currency
date (date): The balance date
>>> balance = Balance('C', '0.00', Date(2010, 7, 22))
>>> balance.status
'C'
>>> balance.amount.amount
Decimal('0.00')
>>> isinstance(balance.date, Date)
True
>>> balance.date.year, balance.date.month, balance.date.day
(2010, 7, 22)
>>> Balance()
<None @ None>
'''
def __init__(self, status=None, amount=None, date=None, **kwargs):
if amount and not isinstance(amount, Amount):
amount = Amount(amount, status, kwargs.get('currency'))
self.status = status
self.amount = amount
self.date = date
def __eq__(self, other):
return self.amount == other.amount and self.status == other.status
def __repr__(self):
return '<%s>' % self
def __str__(self):
return '%s @ %s' % (
self.amount,
self.date, )
class Transactions(abc.Sequence):
'''
Collection of :py:class:`Transaction` objects with global properties such
as begin and end balance
'''
#: Using the processors you can pre-process data before creating objects
#: and modify them after creating the objects
DEFAULT_PROCESSORS = dict(
pre_account_identification=[],
post_account_identification=[],
pre_available_balance=[],
post_available_balance=[],
pre_closing_balance=[],
post_closing_balance=[],
pre_intermediate_closing_balance=[],
post_intermediate_closing_balance=[],
pre_final_closing_balance=[],
post_final_closing_balance=[],
pre_forward_available_balance=[],
post_forward_available_balance=[],
pre_opening_balance=[],
post_opening_balance=[],
pre_intermediate_opening_balance=[],
post_intermediate_opening_balance=[],
pre_final_opening_balance=[],
post_final_opening_balance=[],
pre_related_reference=[],
post_related_reference=[],
pre_statement=[processors.date_fixup_pre_processor],
post_statement=[
processors.date_cleanup_post_processor,
processors.transactions_to_transaction('transaction_reference'),
],
pre_statement_number=[],
post_statement_number=[],
pre_non_swift=[],
post_non_swift=[],
pre_transaction_details=[],
post_transaction_details=[
processors.transaction_details_post_processor
# processors.transaction_details_post_processor_with_space
],
pre_transaction_reference_number=[],
post_transaction_reference_number=[],
pre_floor_limit_indicator=[],
post_floor_limit_indicator=[],
pre_date_time_indication=[],
post_date_time_indication=[],
pre_sum_credit_entries=[],
post_sum_credit_entries=[],
pre_sum_debit_entries=[],
post_sum_debit_entries=[])
def __getstate__(self): # pragma: no cover
# Processors are not always safe to dump so ignore them entirely
state = self.__dict__.copy()
del state['processors']
return state
def __init__(self, processors=None, tags=None):
self.processors = self.DEFAULT_PROCESSORS.copy()
self.tags = Transactions.defaultTags().copy()
if processors:
self.processors.update(processors)
if tags:
self.tags.update(tags)
self.transactions = []
self.data = {}
@property
def currency(self):
balance = mt940.utils.coalesce(
self.data.get('final_opening_balance'),
self.data.get('opening_balance'),
self.data.get('intermediate_opening_balance'),
self.data.get('available_balance'),
self.data.get('forward_available_balance'),
self.data.get('final_closing_balance'),
self.data.get('closing_balance'),
self.data.get('intermediate_closing_balance'),
self.data.get('c_floor_limit'),
self.data.get('d_floor_limit'), )
if balance:
if isinstance(balance, Amount):
return balance.currency
return balance.amount.currency
@staticmethod
def defaultTags():
return mt940.tags.TAG_BY_ID
@classmethod
def strip(cls, lines):
for line in lines:
# We don't like carriage returns in case of Windows files so let's
# just replace them with nothing
line = line.replace('\r', '')
# Strip trailing whitespace from lines since they cause incorrect
# files
line = line.rstrip()
# Skip separators
if line.strip() == '-':
continue
# Return actual lines
if line:
yield line
@classmethod
def normalize_tag_id(cls, tag_id):
# Since non-digit tags exist, make the conversion optional
if tag_id.isdigit():
tag_id = int(tag_id)
return tag_id
def sanitize_tag_id_matches(self, matches):
i_next = 0
for i, match in enumerate(matches):
# match was rejected
if i < i_next:
continue
# next match would be
i_next = i + 1
# normalize tag id
tag_id = self.normalize_tag_id(match.group('tag'))
# tag should be known
assert tag_id in self.tags, 'Unknown tag %r ' \
'in line: %r' % (tag_id, match.group(0))
# special treatment for long tag content with possible
# bad line wrap which produces tag_id like line beginnings
# seen with :86: tag
if tag_id == mt940.tags.Tags.TRANSACTION_DETAILS.value.id:
# search subsequent tags for unknown tag ids
# these lines likely belong to the previous tag
for j in range(i_next, len(matches)):
next_tag_id = self.normalize_tag_id(
matches[j].group('tag'))
if next_tag_id in self.tags:
# this one is the next valid match
i_next = j
break
# else reject match
# a valid match
yield match
def parse(self, data):
'''Parses mt940 data, expects a string with data
Args:
data (str): The MT940 data
Returns: :py:class:`list` of :py:class:`Transaction`
'''
# Remove extraneous whitespace and such
data = '\n'.join(self.strip(data.split('\n')))
# The pattern is a bit annoying to match by regex, even with a greedy
# match it's difficult to get both the beginning and the end so we're
# working around it in a safer way to get everything.
tag_re = re.compile(
r'^:\n?(?P<full_tag>(?P<tag>[0-9]{2}|NS)(?P<sub_tag>[A-Z])?):',
re.MULTILINE)
matches = list(tag_re.finditer(data))
# identify valid matches
valid_matches = list(self.sanitize_tag_id_matches(matches))
for i, match in enumerate(valid_matches):
tag_id = self.normalize_tag_id(match.group('tag'))
# get tag instance corresponding to tag id
tag = self.tags.get(match.group('full_tag')) \
or self.tags[tag_id]
# Nice trick to get all the text that is part of this tag, python
# regex matches have a `end()` and `start()` to indicate the start
# and end index of the match.
if valid_matches[i + 1:i + 2]:
tag_data = \
data[match.end():valid_matches[i + 1].start()].strip()
else:
tag_data = data[match.end():].strip()
tag_dict = tag.parse(self, tag_data)
# Preprocess data before creating the object
for processor in self.processors.get('pre_%s' % tag.slug, []):
tag_dict = processor(self, tag, tag_dict)
result = tag(self, tag_dict)
# Postprocess the object
for processor in self.processors.get('post_%s' % tag.slug, []):
result = processor(self, tag, tag_dict, result)
# Creating a new transaction for :20: and :61: tags allows the
# tags from :20: to :61: to be captured as part of the transaction.
if isinstance(tag, mt940.tags.Statement):
# Transactions only get a Transaction Reference Code ID from a
# :61: tag which is why a new transaction is created if the
# 'id' has a value.
if not self.transactions:
transaction = Transaction(self)
self.transactions.append(transaction)
if transaction.data.get('id'):
transaction = Transaction(self, result)
self.transactions.append(transaction)
else:
transaction.data.update(result)
elif issubclass(tag.scope, Transaction) and self.transactions:
# Combine multiple results together as one string, Rabobank has
# multiple :86: tags for a single transaction
for k, v in _compat.iteritems(result):
if k in transaction.data and hasattr(v, 'strip'):
transaction.data[k] += '\n%s' % v.strip()
else:
transaction.data[k] = v
elif issubclass(tag.scope, Transactions): # pragma: no branch
self.data.update(result)
return self.transactions
def __getitem__(self, key):
return self.transactions[key]
def __len__(self):
return len(self.transactions)
def __repr__(self):
return '<%s[%s]>' % (
self.__class__.__name__,
']['.join('%s: %s' % (k.replace('_balance', ''), v)
for k, v in _compat.iteritems(self.data)
if k.endswith('balance')))
class Transaction(Model):
def __init__(self, transactions, data=None):
self.transactions = transactions
self.data = {}
self.update(data)
def update(self, data):
if data:
self.data.update(data)
def __repr__(self):
return '<%s[%s] %s>' % (
self.__class__.__name__,
self.data.get('date'),
self.data.get('amount'), )
|