summaryrefslogtreecommitdiff
path: root/examples/test_bibparse.py
blob: 12e416ee2d24d73b4854ee10d86e7436a19e1a4a (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
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
""" Test for bibparse grammar """

import unittest
from pyparsing import ParseException
from .btpyparse import Macro
from . import btpyparse as bp

class TestBibparse(unittest.TestCase):
    def test_names(self):
        # check various types of names
        # All names can contains alphas, but not some special chars
        bad_chars = '"#%\'(),={}'
        for name_type, dig1f in ((bp.macro_def, False),
                                 (bp.field_name, False),
                                 (bp.entry_type, False),
                                 (bp.cite_key, True)):
            if dig1f: # can start with digit
                self.assertEqual(name_type.parseString('2t')[0], '2t')
            else:
                self.assertRaises(ParseException, name_type.parseString, '2t')
            # All of the names cannot contain some characters
            for char in bad_chars:
                self.assertRaises(ParseException, name_type.parseString, char)
            # standard strings all OK
            self.assertEqual(name_type.parseString('simple_test')[0], 'simple_test')
        # Test macro ref
        mr = bp.macro_ref
        # can't start with digit
        self.assertRaises(ParseException, mr.parseString, '2t')
        for char in bad_chars:
            self.assertRaises(ParseException, mr.parseString, char)
        self.assertEqual(mr.parseString('simple_test')[0].name, 'simple_test')

    def test_numbers(self):
        self.assertEqual(bp.number.parseString('1066')[0], '1066')
        self.assertEqual(bp.number.parseString('0')[0], '0')
        self.assertRaises(ParseException, bp.number.parseString, '-4')
        self.assertRaises(ParseException, bp.number.parseString, '+4')
        self.assertRaises(ParseException, bp.number.parseString, '.4')
        # something point something leaves a trailing .4 unmatched
        self.assertEqual(bp.number.parseString('0.4')[0], '0')


    def test_parse_string(self):
        # test string building blocks
        self.assertEqual(bp.chars_no_quotecurly.parseString('x')[0], 'x')
        self.assertEqual(bp.chars_no_quotecurly.parseString("a string")[0], 'a string')
        self.assertEqual(bp.chars_no_quotecurly.parseString('a "string')[0], 'a ')
        self.assertEqual(bp.chars_no_curly.parseString('x')[0], 'x')
        self.assertEqual(bp.chars_no_curly.parseString("a string")[0], 'a string')
        self.assertEqual(bp.chars_no_curly.parseString('a {string')[0], 'a ')
        self.assertEqual(bp.chars_no_curly.parseString('a }string')[0], 'a ')
        # test more general strings together
        for obj in (bp.curly_string, bp.string, bp.field_value):
            self.assertEqual(obj.parseString('{}').asList(), [])
            self.assertEqual(obj.parseString('{a "string}')[0], 'a "string')
            self.assertEqual(obj.parseString('{a {nested} string}').asList(),
                        ['a ', ['nested'], ' string'])
            self.assertEqual(obj.parseString('{a {double {nested}} string}').asList(),
                        ['a ', ['double ', ['nested']], ' string'])
        for obj in (bp.quoted_string, bp.string, bp.field_value):
            self.assertEqual(obj.parseString('""').asList(), [])
            self.assertEqual(obj.parseString('"a string"')[0], 'a string')
            self.assertEqual(obj.parseString('"a {nested} string"').asList(),
                        ['a ', ['nested'], ' string'])
            self.assertEqual(obj.parseString('"a {double {nested}} string"').asList(),
                        ['a ', ['double ', ['nested']], ' string'])
        # check macro def in string
        self.assertEqual(bp.string.parseString('someascii')[0], Macro('someascii'))
        self.assertRaises(ParseException, bp.string.parseString, '%#= validstring')
        # check number in string
        self.assertEqual(bp.string.parseString('1994')[0], '1994')


    def test_parse_field(self):
        # test field value - hashes included
        fv = bp.field_value
        # Macro
        self.assertEqual(fv.parseString('aname')[0], Macro('aname'))
        self.assertEqual(fv.parseString('ANAME')[0], Macro('aname'))
        # String and macro
        self.assertEqual(fv.parseString('aname # "some string"').asList(),
                     [Macro('aname'), 'some string'])
        # Nested string
        self.assertEqual(fv.parseString('aname # {some {string}}').asList(),
                     [Macro('aname'), 'some ', ['string']])
        # String and number
        self.assertEqual(fv.parseString('"a string" # 1994').asList(),
                     ['a string', '1994'])
        # String and number and macro
        self.assertEqual(fv.parseString('"a string" # 1994 # a_macro').asList(),
                     ['a string', '1994', Macro('a_macro')])


    def test_comments(self):
        res = bp.comment.parseString('@Comment{about something}')
        self.assertEqual(res.asList(), ['comment', '{about something}'])
        self.assertEqual(
            bp.comment.parseString('@COMMENT{about something').asList(),
            ['comment', '{about something'])
        self.assertEqual(
            bp.comment.parseString('@comment(about something').asList(),
            ['comment', '(about something'])
        self.assertEqual(
            bp.comment.parseString('@COMment about something').asList(),
            ['comment', ' about something'])
        self.assertRaises(ParseException, bp.comment.parseString,
                      '@commentabout something')
        self.assertRaises(ParseException, bp.comment.parseString,
                      '@comment+about something')
        self.assertRaises(ParseException, bp.comment.parseString,
                      '@comment"about something')


    def test_preamble(self):
        res = bp.preamble.parseString('@preamble{"about something"}')
        self.assertEqual(res.asList(), ['preamble', 'about something'])
        self.assertEqual(bp.preamble.parseString(
            '@PREamble{{about something}}').asList(),
            ['preamble', 'about something'])
        self.assertEqual(bp.preamble.parseString("""@PREamble{
            {about something}
        }""").asList(),
            ['preamble', 'about something'])


    def test_macro(self):
        res = bp.macro.parseString('@string{ANAME = "about something"}')
        self.assertEqual(res.asList(), ['string', 'aname', 'about something'])
        self.assertEqual(
            bp.macro.parseString('@string{aname = {about something}}').asList(),
            ['string', 'aname', 'about something'])


    def test_entry(self):
        txt = """@some_entry{akey, aname = "about something",
        another={something else}}"""
        res = bp.entry.parseString(txt)
        self.assertEqual(res.asList(),
                     ['some_entry', 'akey',
                      ['aname', 'about something'], ['another', 'something else']])
        # Case conversion
        txt = """@SOME_ENTRY{akey, ANAME = "about something",
        another={something else}}"""
        res = bp.entry.parseString(txt)
        self.assertEqual(res.asList(),
                     ['some_entry', 'akey',
                      ['aname', 'about something'], ['another', 'something else']])


    def test_bibfile(self):
        txt = """@some_entry{akey, aname = "about something",
        another={something else}}"""
        res = bp.bibfile.parseString(txt)
        self.assertEqual(res.asList(),
                     [['some_entry', 'akey',
                       ['aname', 'about something'],
                       ['another', 'something else']]])


    def test_bib1(self):
        # First pass whole bib-like tests
        txt = """
    Some introductory text
    (implicit comment)

        @ARTICLE{Brett2002marsbar,
      author = {Matthew Brett and Jean-Luc Anton and Romain Valabregue and Jean-Baptise
                Poline},
      title = {{Region of interest analysis using an SPM toolbox}},
      journal = {Neuroimage},
      year = {2002},
      volume = {16},
      pages = {1140--1141},
      number = {2}
    }

    @some_entry{akey, aname = "about something",
    another={something else}}
    """
        res = bp.bibfile.parseString(txt)
        self.assertEqual(len(res), 3)
        res2 = bp.parse_str(txt)
        self.assertEqual(res.asList(), res2.asList())
        res3 = [r.asList()[0] for r, start, end in bp.definitions.scanString(txt)]
        self.assertEqual(res.asList(), res3)


if __name__ == '__main__':
    unittest.main()