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
|
# Copyright (c) 2006-2021 Andrey Golovizin
#
# 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.
from __future__ import absolute_import, unicode_literals
import pickle
from abc import ABCMeta, abstractmethod
from copy import deepcopy
from io import BytesIO, TextIOWrapper
import pytest
from pybtex.database import parse_bytes, parse_string, BibliographyData, Entry
from pybtex.plugin import find_plugin
from .data import reference_data
class DatabaseIO(object):
__metaclass__ = ABCMeta
def __init__(self):
self.reference_data = deepcopy(reference_data)
assert reference_data.entries
assert reference_data.preamble
@abstractmethod
def serialize(self, bib_data):
pass
@abstractmethod
def deserialize(self, bib_data):
pass
class PybtexDatabaseIO(DatabaseIO):
def __init__(self, bib_format):
super(PybtexDatabaseIO, self).__init__()
self.bib_format = bib_format
self.writer = find_plugin('pybtex.database.output', bib_format)(encoding='UTF-8')
self.parser = find_plugin('pybtex.database.input', bib_format)(encoding='UTF-8')
if bib_format == 'bibtexml':
# BibTeXML does not support TeX preambles
self.reference_data._preamble = []
def __repr__(self):
return '{}({!r})'.format(type(self).__name__, self.bib_format)
class PybtexStreamIO(PybtexDatabaseIO):
def serialize(self, bib_data):
stream = BytesIO()
unicode_stream = TextIOWrapper(stream, 'UTF-8')
self.writer.write_stream(bib_data, unicode_stream if self.writer.unicode_io else stream)
unicode_stream.flush()
stream.seek(0)
return unicode_stream
def deserialize(self, stream):
parser_stream = stream if self.parser.unicode_io else stream.buffer
return self.parser.parse_stream(parser_stream)
class PybtexStringIO(PybtexDatabaseIO):
def serialize(self, bib_data):
result = bib_data.to_string(self.bib_format)
assert isinstance(result, str)
return result
def deserialize(self, string):
# wrapper for parse_string
return BibliographyData.from_string(string, self.bib_format)
class PybtexEntryStringIO(PybtexDatabaseIO):
# the first entry in reference_data
def __init__(self, bib_format):
super(PybtexEntryStringIO, self).__init__(bib_format)
# get 1st key
self.key = list(reference_data.entries.keys())[0]
# make Entry as single-item BibliographyData
self.reference_data = reference_data.entries[self.key]
assert reference_data.entries
assert reference_data.preamble
def serialize(self, bib_data): # Entry.to_string
result = bib_data.to_string(self.bib_format)
assert isinstance(result, str)
return result
def deserialize(self, string): # Entry.from_string
return Entry.from_string(string, self.bib_format)
class PybtexBytesIO(PybtexDatabaseIO):
def serialize(self, bib_data):
result = bib_data.to_bytes(self.bib_format)
assert isinstance(result, bytes)
return result
def deserialize(self, string):
return parse_bytes(string, self.bib_format)
class PickleIO(DatabaseIO):
def __init__(self, protocol):
super(PickleIO, self).__init__()
self.protocol = protocol
def __repr__(self):
return '{}(protocol={!r})'.format(type(self).__name__, self.protocol)
def serialize(self, bib_data):
return pickle.dumps(bib_data, protocol=self.protocol)
def deserialize(self, pickled_data):
return pickle.loads(pickled_data)
class ReprEvalIO(DatabaseIO):
def __repr__(self):
return '{}()'.format(type(self).__name__)
def serialize(self, bib_data):
return repr(bib_data)
def deserialize(self, repr_value):
from pybtex.utils import OrderedCaseInsensitiveDict
from pybtex.database import BibliographyData, Entry, Person
return eval(repr_value, {
'OrderedCaseInsensitiveDict': OrderedCaseInsensitiveDict,
'BibliographyData': BibliographyData,
'Entry': Entry,
'Person': Person,
})
def check_database_io(io_obj):
serialized_data = io_obj.serialize(io_obj.reference_data)
deserialized_data = io_obj.deserialize(serialized_data)
assert deserialized_data == io_obj.reference_data
@pytest.mark.parametrize(["io_cls"], [(PybtexBytesIO,), (PybtexStringIO,), (PybtexEntryStringIO,),(PybtexBytesIO,)])
@pytest.mark.parametrize(["bib_format"], [("bibtex",), ("bibtexml",), ("yaml",)])
def test_database_io(io_cls, bib_format):
check_database_io(io_cls(bib_format))
@pytest.mark.parametrize(
["protocol"],
[(protocol,) for protocol in range(0, pickle.HIGHEST_PROTOCOL + 1)]
)
def test_database_pickling(protocol):
check_database_io(PickleIO(protocol))
def test_database_repr():
check_database_io(ReprEvalIO())
|
