def test_recktype_with_bad_sequence(self):
with self.assertRaises(ValueError):
# 3-tuple instead of 2-tuple
Rec = recktype('Rec', [('a', 1, 2)])
with self.assertRaises(ValueError):
# 1-tuple instead of 2-tuple
Rec = recktype('Rec', [('a',)])
def test_recktype_with_defaults(self):
Rec = recktype('Rec', dict(a=1))
rec = Rec()
self.assertEqual(rec.a, 1)
Rec = recktype('Rec', [('a', 1), 'b', ('c', 3)])
rec = Rec(b=2)
self.assertEqual(rec.a, 1)
self.assertEqual(rec.b, 2)
self.assertEqual(rec.c, 3)
def test_bad_typename(self):
with self.assertRaises(ValueError):
# Typename is a keyword
R = recktype('for', ['a', 'b'])
with self.assertRaises(ValueError):
# Typename with a leading digit
R = recktype('1R', ['a', 'b'])
with self.assertRaises(ValueError):
# Typename contains a non alpha-numeric/underscore character
R = recktype('R-', ['a', 'b'])
def test_recktype_with_default_factory(self):
# default factory with no args/kwargs
Rec = recktype('Rec', ['a', ('b', DefaultFactory(list))])
rec1 = Rec(a=1)
rec2 = Rec(a=1)
self.assertEqual(rec1.a, 1)
self.assertEqual(rec1.b, [])
rec1.b.append(2)
rec1.b.append(3)
self.assertEqual(rec1.b, [2, 3])
self.assertNotEqual(rec1.b, rec2.b)
self.assertEqual(rec2.b, [])
# default factory with args
Rec = recktype('Rec', [
'a',
('b', DefaultFactory(list, args=([1, 2],)))])
rec1 = Rec(a=1)
rec2 = Rec(a=1)
self.assertEqual(rec1.a, 1)
self.assertEqual(rec1.b, [1, 2])
rec1.b.append(3)
self.assertEqual(rec1.b, [1, 2, 3])
self.assertNotEqual(rec1.b, rec2.b)
self.assertEqual(rec2.b, [1, 2])
# default factory with kwargs
Rec = recktype('Rec', [
'a',
('b', DefaultFactory(dict, kwargs=dict(val1=1, val2=2)))])
rec1 = Rec(a=1)
rec2 = Rec(a=1)
self.assertEqual(rec1.a, 1)
self.assertEqual(rec1.b, {'val1': 1, 'val2': 2})
rec1.b['val3'] = 3
self.assertEqual(rec1.b, dict(val1=1, val2=2, val3=3))
self.assertNotEqual(rec1.b, rec2.b)
self.assertEqual(rec2.b, dict(val1=1, val2=2))
# default factory with args and kwargs
Rec = recktype('Rec', [
'a',
('b', DefaultFactory(
dict, args=([('val1', 1)],), kwargs=dict(val2=2)))])
rec1 = Rec(a=1)
rec2 = Rec(a=1)
self.assertEqual(rec1.a, 1)
self.assertEqual(rec1.b, {'val1': 1, 'val2': 2})
rec1.b['val3'] = 3
self.assertEqual(rec1.b, dict(val1=1, val2=2, val3=3))
self.assertNotEqual(rec1.b, rec2.b)
self.assertEqual(rec2.b, dict(val1=1, val2=2))
def test_rename(self):
# Duplicate fieldname
R = recktype('R', ['a', 'a', 'b', 'a'], rename=True)
self.assertEqual(R._fieldnames, ('a', '_1', 'b', '_3'))
# Fieldname with leading underscore
R = recktype('R', ['a', '_b'], rename=True)
self.assertEqual(R._fieldnames, ('a', '_1'))
# Fieldname is a keyword
R = recktype('R', ['a', 'for'], rename=True)
self.assertEqual(R._fieldnames, ('a', '_1'))
# Fieldname with a leading digit
R = recktype('R', ['a', '1b'], rename=True)
self.assertEqual(R._fieldnames, ('a', '_1'))
# Fieldname contains a non alpha-numeric chanacter/underscore char
R = recktype('R', ['a', 'b!'], rename=True)
self.assertEqual(R._fieldnames, ('a', '_1'))
# Multiple rename required
R = recktype(
'R', ['a', 'a', 'b!', 'c', 'for'], rename=True)
self.assertEqual(R._fieldnames, ('a', '_1', '_2', 'c', '_4'))
# Rename should not break anything when all fieldnames are valid
R = recktype('R', ['a', 'b', 'c'], rename=True)
self.assertEqual(R._fieldnames, ('a', 'b', 'c'))
# Rename with defaults
R = recktype('R', [('_a', 1), ('b!', 2)], rename=True)
r = R()
self.assertEqual(r._0, 1)
self.assertEqual(r._1, 2)
def test_count(self):
R = recktype('R', 'a b c')
rec = R(1, 2, 2)
c =rec._count(1)
self.assertEqual(rec._count(1), 1)
self.assertEqual(rec._count(2), 2)
# Test it still works if one of the fields is called count. This is
# done because _count() calls the baseclass count() (inherited from
# collections.Sequence
R = recktype('R', 'a b count')
rec = R(1, 2, 2)
self.assertEqual(rec.count, 2)
self.assertEqual(rec._count(1), 1)
self.assertEqual(rec._count(2), 2)
def test_asdict(self):
fieldnames = list('abcdefgh')
values = [1, 2, 3, 4, 5, 6, 7, 8]
Rec = recktype('Rec', fieldnames)
rec = Rec(*values)
od = OrderedDict(zip(fieldnames, values))
self.assertEqual(rec._asdict(), od)
def test_setitem(self):
R = recktype('R', ['a', 'b', 'c', 'd', 'e'])
rec = R(1, 2, 3, 4, 5)
# Test __setitem__ by numerical index
rec[0] = 99
self.assertEqual(rec.a, 99)
# Test __setitem__ by slice with correct number of values
rec[2:] = [101, 102, 103]
self.assertEqual(rec.c, 101)
self.assertEqual(rec.d, 102)
self.assertEqual(rec.e, 103)
# Test __setitem__ by slice with too many values
rec[:2] = [1000, 1001, 1002]
self.assertEqual(rec.a, 1000)
self.assertEqual(rec.b, 1001)
self.assertEqual(rec.c, 101) # Should remain unchanged
# Test __setitem__ by slice with too few values
rec[:2] = [2000]
self.assertEqual(rec.a, 2000)
self.assertEqual(rec.b, 1001)
self.assertEqual(rec.c, 101) # Should remain unchanged
def test_index(self):
rec = Rec(1, 2)
self.assertEqual(rec._index(2), 1)
R = recktype('R', 'a b c d')
rec = R(1, 2, 2, 3)
self.assertEqual(rec._index(2), 1) # 1st occurrence of 2
self.assertEqual(rec._index(3), 3)
# Test it still works if one of the fields is called count. This is
# done because _index() is set to the baseclass index() (implemented by
# collections.Sequence)
R = recktype('R', 'a b c index')
rec = R(1, 2, 2, 3)
self.assertEqual(rec.index, 3)
self.assertEqual(rec._index(2), 1) # 1st occurrence of 2
self.assertEqual(rec._index(3), 3)
def test_init_with_more_than_255_fields(self):
nfields = 5000
fieldnames = ['f{0}'.format(i) for i in range(nfields)]
values = [i for i in range(nfields)]
kwargs = {k: v for k, v in zip(fieldnames, values)}
# With values unpacked to positional arguments
Rec = recktype('Rec', fieldnames)
rec = Rec(*values)
self.assertEqual(rec.f0, 0)
self.assertEqual(getattr(rec, 'f{0}'.format(nfields - 1)), nfields - 1)
# With values unpacked to keyword arguments
Rec = recktype('Rec', fieldnames)
rec = Rec(**kwargs)
self.assertEqual(rec.f0, 0)
self.assertEqual(rec.f0, 0)
self.assertEqual(getattr(rec, 'f{0}'.format(nfields - 1)), nfields - 1)
def test_recktype_with_mapping(self):
# Use lots of fields to check that field order is preserved
nfields = 50
fieldnames = ['f{0}'.format(i) for i in range(nfields)]
tuples = [(name, None) for name in fieldnames]
Rec = recktype('Rec', OrderedDict(tuples))
rec = Rec(*list(range(nfields)))
for i in range(nfields):
self.assertEqual(rec[i], i)
fieldname = 'f{0}'.format(i)
self.assertEqual(getattr(rec, fieldname), i)
def test_field_order(self):
# Checks that the order in which fields are specified in the
# fields argument of the constructor are preserved in __slots__
fields = (
['field_b', 'field_d', 'field_c', 'field_f', 'field_e', 'field_a'])
Rec = recktype('Rec', fields)
rec = Rec(*list(range(len(fields))))
self.assertEqual(rec.field_b, 0)
self.assertEqual(rec.field_d, 1)
self.assertEqual(rec.field_c, 2)
self.assertEqual(rec.field_f, 3)
self.assertEqual(rec.field_e, 4)
self.assertEqual(rec.field_a, 5)
def test_update_with_bad_args(self):
Rec = recktype('Rec', 'a b')
rec = Rec(1, 2)
with self.assertRaises(TypeError):
# Initialisation with too many positional arguments
rec._update(3, 4, 5)
with self.assertRaises(TypeError):
# Initialisation with a non-existent fieldname
rec._update(3, c=4)
with self.assertRaises(TypeError):
# Redefinition of positional arg with keyword arg
rec._update(3, 4, a=5)
def test_replace_defaults(self):
Rec = recktype('Rec', ['a', ('b', 2), ('c', 3)])
self.assertEqual(Rec._get_defaults(), dict(b=2, c=3))
# With args
Rec._replace_defaults(1, 2)
self.assertEqual(Rec._get_defaults(), dict(a=1, b=2))
# With kwargs
Rec._replace_defaults(a=3, b=4)
self.assertEqual(Rec._get_defaults(), dict(a=3, b=4))
# With args and kwargs
Rec._replace_defaults(5, 6, c=7)
self.assertEqual(Rec._get_defaults(), dict(a=5, b=6, c=7))
def test_bad_fieldname(self):
with self.assertRaises(ValueError):
# Duplicate fieldname
R = recktype('R', ['a', 'a', 'b', 'a'])
with self.assertRaises(ValueError):
# Fieldname with leading underscore
R = recktype('R', ['a', '_b'])
with self.assertRaises(ValueError):
# Fieldname is a keyword
R = recktype('R', ['a', 'for'])
with self.assertRaises(ValueError):
# Fieldname with a leading digit
R = recktype('R', ['a', '1b'])
with self.assertRaises(ValueError):
# Fieldname contains a non alpha-numeric character/underscore char
R = recktype('R', ['a', 'b!'])
with self.assertRaises(ValueError):
# tuple of len 1 (2-tuple is required)
R = recktype('R', [('a',)])
with self.assertRaises(ValueError):
# tuple of len 3 (2-tuple is required)
R = recktype('R', [('a', 1, 1)])
with self.assertRaises(ValueError):
# Non-string/2-tuple fieldname
R = recktype('R', ['a', {'b': 1}])
with self.assertRaises(TypeError):
# Non-string/2-tuple fieldname
R = recktype('R', ['a', 1])
def test_getitem(self):
R = recktype('R', ['a', 'b', 'c', 'd'])
rec = R(1, 2, 3, 4)
# Test access by numerical index
self.assertEqual(rec[0], 1)
# Test slicing
slice = rec[:3]
self.assertEqual(slice, [1, 2, 3])
slice = rec[:3:2]
self.assertEqual(slice, [1, 3])
# Test that passing an non-int/str/slice object raises a TypeError
with self.assertRaises(TypeError):
slice = rec[object]
# A value outside the set of indexes for the sequence should
# raise an IndexError
with self.assertRaises(IndexError):
_ = rec[99999]
def test_get_defaults(self):
Rec = recktype('Rec', ['a', ('b', 2), ('c', 3)])
self.assertEqual(Rec._get_defaults(), dict(b=2, c=3))
def test_recktype_with_sequence(self):
# Simple sequence
Rec = recktype('Rec', ['a', 'b'])
rec = Rec(1, 2)
self.assertEqual(rec.a, 1)
self.assertEqual(rec.b, 2)
# Sequence of 2-tuples
Rec = recktype('Rec', [('a', None), ('b', None)])
rec = Rec(1, 2)
self.assertEqual(rec.a, 1)
self.assertEqual(rec.b, 2)
# Simple sequence with some 2-tuples
Rec = recktype('Rec', ['a', ('b', None)])
rec = Rec(1, 2)
self.assertEqual(rec.a, 1)
self.assertEqual(rec.b, 2)
# String sequence
Rec = recktype('Rec', 'a b,c, d')
rec = Rec(1, 2, 3, 4)
self.assertEqual(rec.a, 1)
self.assertEqual(rec.b, 2)
self.assertEqual(rec.c, 3)
self.assertEqual(rec.d, 4)
Rec = recktype('Rec', 'ab')
rec = Rec(1)
self.assertEqual(rec.ab, 1)
# With DefaultFactory with no args/kwargs
Rec = recktype('Rec', ['a', ('b', DefaultFactory(list))])
rec1 = Rec(a=1)
rec2 = Rec(a=1)
self.assertEqual(rec1.a, 1)
self.assertEqual(rec1.b, [])
rec1.b.append(2)
rec1.b.append(3)
self.assertEqual(rec1.b, [2, 3])
# Check rec2 doesn't share the list with rec1
self.assertEqual(rec2.b, [])
# With DefaultFactory with args
Rec = recktype('Rec', [
('a', DefaultFactory(list, args=[[1, 2]]))])
rec1 = Rec()
rec2 = Rec()
self.assertEqual(rec1.a, [1, 2])
rec1.a.append(3)
self.assertEqual(rec1.a, [1, 2, 3])
# Check rec2 doesn't share the list with rec1
self.assertEqual(rec2.a, [1, 2])
# With DefaultFactory with kwargs
kwargs = {'a': 1}
Rec = recktype('Rec', [
('a', DefaultFactory(dict, kwargs=kwargs))])
rec1 = Rec()
rec2 = Rec()
self.assertEqual(rec1.a, kwargs)
rec1.a['b'] = 2
self.assertEqual(rec1.a, {'a': 1, 'b': 2})
# Check rec2 doesn't share the list with rec1
self.assertEqual(rec2.a, kwargs)
# With DefaultFactory with args and kwargs
args = [[('a', 1), ('b', 2)]]
kwargs = {'c': 3}
dct = dict(*args, **kwargs)
Rec = recktype('Rec', [
('a', DefaultFactory(dict, args=args, kwargs=kwargs))])
rec1 = Rec()
rec2 = Rec()
self.assertEqual(rec1.a, dct)
rec1.a['d'] = 4
# Check rec2 doesn't share the list with rec1
self.assertEqual(rec2.a, dct)
dct.update(d=4)
self.assertEqual(rec1.a, dct)
from collections import OrderedDict
import pickle
from sys import version_info
import unittest
from reck import recktype, DefaultFactory
Rec = recktype('Rec', ['a', 'b'])
class TestDefaultFactory(unittest.TestCase):
def test_call(self):
# With no args
df = DefaultFactory(list)
self.assertEqual(df(), [])
df = DefaultFactory(dict)
self.assertEqual(df(), {})
# With an arg
df = DefaultFactory(list, args=[(1, 2, 3)])
self.assertEqual(df(), [1, 2, 3])
df = DefaultFactory(dict, args=[[('a', 1), ('b', 2)]])
self.assertEqual(df(), {'a': 1, 'b': 2})
# With kwargs
df = DefaultFactory(dict, kwargs={'a': 1, 'b': 2})
self.assertEqual(df(), {'a': 1, 'b': 2})
# With args and kwargs
