summaryrefslogtreecommitdiff
path: root/src/zope/tales/tests/test_traverser.py
blob: dd9eb0dcdc8c10c2ba21737f272f06554ae05053 (plain)
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
##############################################################################
#
# Copyright (c) 2005 Zope Foundation and Contributors.
# All Rights Reserved.
#
# This software is subject to the provisions of the Zope Public License,
# Version 2.1 (ZPL).  A copy of the ZPL should accompany this distribution.
# THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL EXPRESS OR IMPLIED
# WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
# WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS
# FOR A PARTICULAR PURPOSE.
#
##############################################################################
""" Tests for zope.tales.expressions.simpleTraverse
"""
from unittest import TestCase
from zope.tales.expressions import simpleTraverse


class AttrTraversable(object):
    """Traversable by attribute access"""
    attr = 'foo'


class ItemTraversable(object):
    """Traversable by item access"""

    def __getitem__(self, name):
        if name == 'attr':
            return 'foo'
        raise KeyError(name)


class AllTraversable(AttrTraversable, ItemTraversable):
    """Traversable by attribute and item access"""
    pass


_marker = object()


def getitem(ob, name, default=_marker):
    """Helper a la getattr(ob, name, default)."""
    try:
        item = ob[name]
    except KeyError:
        if default is not _marker:
            return default
        raise KeyError(name)
    else:
        return item


class TraverserTests(TestCase):

    def testGetItem(self):
        # getitem helper should behave like __getitem__
        ob = {'attr': 'foo'}
        self.assertEqual(getitem(ob, 'attr', None), 'foo')
        self.assertEqual(getitem(ob, 'attr'), 'foo')
        self.assertEqual(getitem(ob, 'missing_attr', None), None)
        self.assertRaises(KeyError, getitem, ob, 'missing_attr')
        self.assertRaises(TypeError, getitem, object(), 'attr')

    def testAttrTraversable(self):
        # An object without __getitem__ should raise AttributeError
        # for missing attribute.
        ob = AttrTraversable()
        self.assertEqual(getattr(ob, 'attr', None), 'foo')
        self.assertRaises(AttributeError, getattr, ob, 'missing_attr')

    def testItemTraversable(self):
        # An object with __getitem__ (but without attr) should raise
        # KeyError for missing attribute.
        ob = ItemTraversable()
        self.assertEqual(getitem(ob, 'attr', None), 'foo')
        self.assertRaises(KeyError, getitem, ob, 'missing_attr')

    def testAllTraversable(self):
        # An object with attr and __getitem__ should raise either
        # exception, depending on method of access.
        ob = AllTraversable()
        self.assertEqual(getattr(ob, 'attr', None), 'foo')
        self.assertRaises(AttributeError, getattr, ob, 'missing_attr')
        self.assertEqual(getitem(ob, 'attr', None), 'foo')
        self.assertRaises(KeyError, getitem, ob, 'missing_attr')

    def testTraverseEmptyPath(self):
        # simpleTraverse should return the original object if the path is empty
        ob = object()
        self.assertEqual(simpleTraverse(ob, [], None), ob)

    def testTraverseByAttr(self):
        # simpleTraverse should find attr through attribute access
        ob = AttrTraversable()
        self.assertEqual(simpleTraverse(ob, ['attr'], None), 'foo')

    def testTraverseByMissingAttr(self):
        # simpleTraverse should raise AttributeError
        ob = AttrTraversable()
        # Here lurks the bug (unexpected NamError raised)
        self.assertRaises(
            AttributeError, simpleTraverse, ob, ['missing_attr'], None)

    def testTraverseByItem(self):
        # simpleTraverse should find attr through item access
        ob = ItemTraversable()
        self.assertEqual(simpleTraverse(ob, ['attr'], None), 'foo')

    def testTraverseByMissingItem(self):
        # simpleTraverse should raise KeyError
        ob = ItemTraversable()
        self.assertRaises(KeyError, simpleTraverse, ob, ['missing_attr'], None)

    def testTraverseByAll(self):
        # simpleTraverse should find attr through attribute access
        ob = AllTraversable()
        self.assertEqual(simpleTraverse(ob, ['attr'], None), 'foo')

    def testTraverseByMissingAll(self):
        # simpleTraverse should raise KeyError (because ob implements
        # __getitem__)
        ob = AllTraversable()
        self.assertRaises(KeyError, simpleTraverse, ob, ['missing_attr'], None)