Source code for pyfwf.columns

"""
The MIT License (MIT)

Copyright 2015 Umbrella Tech.

Permission is hereby granted, free of charge, to any person obtaining a copy of
this software and associated documentation files (the "Software"), to deal in
the Software without restriction, including without limitation the rights to
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
the Software, and to permit persons to whom the Software is furnished to do so,
subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
"""

__author__ = "Kelson da Costa Medeiros <kelsoncm@gmail.com>"


import re
from datetime import date, datetime, time

from .hydrating import Hydrator


[docs] class AbstractColumn(Hydrator): to_str_assertion_types = None to_str_assertion_class = None to_str_none_pad = None to_str_pad_template = None hydrating_args = ["name", "size", "description"] def __init__(self, _name: str, size: int, description: str = None): super(AbstractColumn, self).__init__() if not isinstance(_name, str): raise TypeError("O campo name deve ser uma string") if not (_name and _name.rstrip()): raise ValueError("O campo column_name deve ser uma string válida e não branca") if not isinstance(size, int): raise TypeError("O campo size deve ser um inteiro") if size <= 0: raise ValueError("O campo size deve ser maior que 0") if description is None: description = _name else: if not isinstance(description, str): raise TypeError("O campo description deve ser uma string") self.name = _name self.size = size self.description = description self.start = None @property def end(self): if not isinstance(self.start, int): raise TypeError("O campo start deve ser um inteiro") if self.start <= 0: raise ValueError("O campo start deve ser maior que 0") return self.start + self.size - 1
[docs] def to_value(self, slice): if not isinstance(slice, str): raise TypeError("Informe uma string para converter corretamente") if len(slice) != self.size: raise ValueError("A string deve ter exatamente o tamanho do campo '%s' (%s)" % (self.name, self.size)) return slice
def _validate_to_str_size(self, value): if len(value) != self.size: raise ValueError( "O valor a ser serializado para o campo '%s' não pode ser diferente de %d " % (self.name, self.size) ) return value
[docs] def to_str_assertion(self, value): return isinstance(value, self.to_str_assertion_class)
[docs] def to_str(self, value: str): if not (value is None or self.to_str_assertion(value)): raise TypeError("O campo '%s' só aceita '%s' or 'None'" % (self.name, self.to_str_assertion_types)) if value is None: return self.to_str_none_pad * self.size else: return self._validate_to_str_size((self.to_str_pad_template % self.size).format(value))
[docs] class CharColumn(AbstractColumn): to_str_assertion_types = "str" to_str_assertion_class = str to_str_none_pad = " " to_str_pad_template = "{0: <%d}"
[docs] def to_value(self, slice: str): return super(CharColumn, self).to_value(slice).strip()
[docs] class RightCharColumn(CharColumn): to_str_pad_template = "{0: >%d}"
[docs] class PositiveIntegerColumn(AbstractColumn): to_str_assertion_types = "positive int" to_str_assertion_class = int to_str_none_pad = "0" to_str_pad_template = "{0:0%dd}"
[docs] def to_str_assertion(self, value): return isinstance(value, int) and not isinstance(value, bool) and value >= 0
[docs] def to_value(self, slice: str): _value = int(super(PositiveIntegerColumn, self).to_value(slice)) if _value < 0: raise ValueError( "Informe uma string para converter corretamente, '%s' não é um '%s'" % (slice, self.to_str_assertion_types) ) return _value
[docs] class PositiveDecimalColumn(PositiveIntegerColumn): to_str_assertion_types = "positive decimal" to_str_assertion_class = float hydrating_args = ["name", "size", "decimals", "description"] def __init__(self, _name: str, size: int, decimals: int = 2, description: str = None): super(PositiveDecimalColumn, self).__init__(_name, size, description) if not isinstance(decimals, int): raise TypeError("Os decimais devem ser um inteiro") if decimals <= 0: raise ValueError("Os decimais devem ser maior que 0") if size <= decimals: raise ValueError("Os decimais devem ser menores que o size") self.decimals = decimals
[docs] def to_value(self, slice: str): return super(PositiveDecimalColumn, self).to_value(slice) / pow(10, self.decimals)
[docs] def to_str_assertion(self, value): return isinstance(value, float) and not isinstance(value, bool) and value >= 0.0
[docs] def to_str(self, value: str): if not (value is None or self.to_str_assertion(value)): raise TypeError("O campo '%s' só aceita '%s' or 'None'" % (self.name, self.to_str_assertion_types)) if value is None: return self.to_str_none_pad * self.size else: _value = int(value * pow(10, self.decimals)) return self._validate_to_str_size((self.to_str_pad_template % self.size).format(_value))
[docs] class DateTimeColumn(AbstractColumn): to_str_assertion_types = "datetime" to_str_assertion_class = datetime to_str_none_pad = "0" format_num_elements = 5 hydrating_args = ["name", "format", "description"] def __init__(self, _name: str, _format: str = "%d%m%Y%H%M", description: str = None): if not isinstance(_name, str): raise TypeError("O campo name deve ser uma string") if not (_name and _name.strip()): raise ValueError("O campo column_name deve ser uma string válida e não branca") if not isinstance(_format, str): raise TypeError("O argumento '_format' do campo '%s' deve ser uma string" % _name) if not (_format and _format.strip()): raise ValueError("O argumento '_format' do campo '%s' deve ser uma string válida e não branca" % _name) if len([x for x in re.finditer(re.compile("(%[a-z,A-Z])"), _format)]) != self.format_num_elements: raise ValueError( "O argumento '_format' (%s) do campo '%s' deve ter um formato de data/hora válido" % (_format, _name) ) _size = len(datetime(2001, 12, 31, 13, 59).strftime(_format)) self.to_str_pad_templating = "" super(DateTimeColumn, self).__init__(_name, _size, description) self.format = _format
[docs] def to_value(self, slice: str): _value = super(DateTimeColumn, self).to_value(slice) try: if _value == self.to_str_none_pad * self.size: return None else: return datetime.strptime(_value, self.format) except ValueError: raise ValueError( "O valor '%s' do campo '%s' é inválido para o formato '%s'" % (_value, self.name, self.format) )
[docs] def to_str(self, value: datetime): if not (value is None or self.to_str_assertion(value)): raise TypeError("O campo '%s' só aceita '%s' or 'None'" % (self.name, self.to_str_assertion_types)) if value is None: return self.to_str_none_pad * self.size else: return self._validate_to_str_size(value.strftime(self.format))
[docs] class DateColumn(DateTimeColumn): to_str_assertion_types = "date" to_str_assertion_class = date format_num_elements = 3 def __init__(self, _name: str, _format: str = "%d%m%Y", description: str = None): super(DateColumn, self).__init__(_name, _format, description)
[docs] def to_value(self, slice: str): result = super(DateColumn, self).to_value(slice) return result.date() if result is not None else None
[docs] class TimeColumn(DateTimeColumn): to_str_assertion_types = "time" to_str_assertion_class = time format_num_elements = 2 def __init__(self, _name: str, _format: str = "%H%M", description: str = None): super(TimeColumn, self).__init__(_name, _format, description)
[docs] def to_value(self, slice: str): result = super(TimeColumn, self).to_value(slice) return result.time() if result is not None else None