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
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
|
# coding: utf-8
# Copyright (c) 2016, Science and Technology Facilities Council
# This software is distributed under a BSD licence. See LICENSE.txt.
"""
Tests for utils.py
"""
# Import Python 3 features for future-proofing
# Deliberately do NOT import unicode_literals due to a bug in numpy dtypes:
# https://github.com/numpy/numpy/issues/2407
# and also because some tests for string <-> byte conversion need to test both unicode
# and non-unicode literals.
from __future__ import absolute_import, division, print_function
import sys
import unittest
import numpy as np
import mrcfile.utils as utils
from .helpers import AssertRaisesRegexMixin
from mrcfile.dtypes import HEADER_DTYPE
class UtilsTest(AssertRaisesRegexMixin, unittest.TestCase):
"""Unit tests for mrcfile.utils"""
def test_header_dtype_is_correct_length(self):
assert HEADER_DTYPE.itemsize == 1024
def test_mode_0_is_converted_to_int8(self):
dtype = utils.dtype_from_mode(0)
assert dtype == np.dtype(np.int8)
def test_mode_1_is_converted_to_int16(self):
dtype = utils.dtype_from_mode(1)
assert dtype == np.dtype(np.int16)
def test_mode_2_is_converted_to_float32(self):
dtype = utils.dtype_from_mode(2)
assert dtype == np.dtype(np.float32)
def test_mode_3_raises_exception(self):
with self.assertRaises(ValueError):
utils.dtype_from_mode(3)
def test_mode_4_is_converted_to_complex64(self):
dtype = utils.dtype_from_mode(4)
assert dtype == np.dtype(np.complex64)
def test_mode_6_is_converted_to_uint16(self):
dtype = utils.dtype_from_mode(6)
assert dtype == np.dtype(np.uint16)
def test_undefined_modes_raise_exception(self):
for mode in (x for x in range(-33, 34, 1) if x not in [0, 1, 2, 4, 6, 12]):
with self.assertRaises(ValueError):
utils.dtype_from_mode(mode)
def test_mode_scalar_is_converted_without_error(self):
dtype = utils.dtype_from_mode(np.float32(1))
assert dtype == np.dtype(np.int16)
def test_mode_zerodim_array_is_converted_without_error(self):
dtype = utils.dtype_from_mode(np.array(1))
assert dtype == np.dtype(np.int16)
def test_mode_onedim_array_is_converted_without_error(self):
dtype = utils.dtype_from_mode(np.array([1]))
assert dtype == np.dtype(np.int16)
def test_float16_dtype_is_converted_to_mode_12(self):
mode = utils.mode_from_dtype(np.dtype(np.float16))
assert mode == 12
def test_float32_dtype_is_converted_to_mode_2(self):
mode = utils.mode_from_dtype(np.dtype(np.float32))
assert mode == 2
def test_float64_dtype_raises_exception(self):
with self.assertRaises(ValueError):
utils.mode_from_dtype(np.dtype(np.float64))
def test_float128_dtype_raises_exception(self):
# float128 only exists on some platforms
if hasattr(np, 'float128'):
with self.assertRaises(ValueError):
utils.mode_from_dtype(np.dtype(np.float128))
def test_int8_dtype_is_converted_to_mode_0(self):
mode = utils.mode_from_dtype(np.dtype(np.int8))
assert mode == 0
def test_int16_dtype_is_converted_to_mode_1(self):
mode = utils.mode_from_dtype(np.dtype(np.int16))
assert mode == 1
def test_int32_dtype_raises_exception(self):
with self.assertRaises(ValueError):
utils.mode_from_dtype(np.dtype(np.int32))
def test_int64_dtype_raises_exception(self):
with self.assertRaises(ValueError):
utils.mode_from_dtype(np.dtype(np.int64))
def test_uint8_dtype_is_converted_to_mode_6(self):
mode = utils.mode_from_dtype(np.dtype(np.uint8))
assert mode == 6
def test_uint16_dtype_is_converted_to_mode_6(self):
mode = utils.mode_from_dtype(np.dtype(np.uint16))
assert mode == 6
def test_uint32_dtype_raises_exception(self):
with self.assertRaises(ValueError):
utils.mode_from_dtype(np.dtype(np.uint32))
def test_uint64_dtype_raises_exception(self):
with self.assertRaises(ValueError):
utils.mode_from_dtype(np.dtype(np.uint64))
def test_complex64_dtype_is_converted_to_mode_4(self):
mode = utils.mode_from_dtype(np.dtype(np.complex64))
assert mode == 4
def test_complex128_dtype_raises_exception(self):
with self.assertRaises(ValueError):
utils.mode_from_dtype(np.dtype(np.complex128))
def test_string_dtype_raises_exception(self):
with self.assertRaises(ValueError):
utils.mode_from_dtype(np.dtype('S1'))
def test_unicode_dtype_raises_exception(self):
with self.assertRaises(ValueError):
utils.mode_from_dtype(np.dtype('U1'))
def test_bool_dtype_raises_exception(self):
with self.assertRaises(ValueError):
utils.mode_from_dtype(np.dtype(bool))
def test_object_dtype_raises_exception(self):
with self.assertRaises(ValueError):
utils.mode_from_dtype(np.dtype(object))
def test_structured_dtype_raises_exception(self):
with self.assertRaises(ValueError):
utils.mode_from_dtype(np.dtype([('f1', np.int32)]))
def test_little_endian_machine_stamp(self):
machst = utils.machine_stamp_from_byte_order('<')
assert machst == bytearray((0x44, 0x44, 0x00, 0x00))
def test_big_endian_machine_stamp(self):
machst = utils.machine_stamp_from_byte_order('>')
assert machst == bytearray((0x11, 0x11, 0x00, 0x00))
def test_native_machine_stamp(self):
machst = utils.machine_stamp_from_byte_order()
if sys.byteorder == 'little':
assert machst == utils.machine_stamp_from_byte_order('<')
else:
assert machst == utils.machine_stamp_from_byte_order('>')
def test_normalise_little_endian_byte_order(self):
assert utils.normalise_byte_order('<') == '<'
def test_normalise_big_endian_byte_order(self):
assert utils.normalise_byte_order('>') == '>'
def test_normalise_native_byte_order(self):
if sys.byteorder == 'little':
assert utils.normalise_byte_order('=') == '<'
else:
assert utils.normalise_byte_order('=') == '>'
def test_normalise_unknown_byte_orders(self):
for byte_order in ['|', 'I', 'other', 'S', 'N', 'L', 'B']:
with self.assertRaisesRegex(ValueError,
"Unrecognised byte order indicator"):
utils.normalise_byte_order(byte_order)
def test_native_byte_orders_equal(self):
assert utils.byte_orders_equal('=', '=')
def test_little_byte_order_equals_native(self):
assert utils.byte_orders_equal('<', '=') == (sys.byteorder == 'little')
def test_big_byte_order_equals_native(self):
assert utils.byte_orders_equal('>', '=') == (sys.byteorder == 'big')
def test_little_byte_orders_equal(self):
assert utils.byte_orders_equal('<', '<')
def test_big_byte_orders_equal(self):
assert utils.byte_orders_equal('>', '>')
def test_unequal_byte_orders(self):
assert not utils.byte_orders_equal('>', '<')
def test_equality_of_invalid_byte_orders(self):
for pair in [('|', '<'),
('|', '>'),
('|', '='),
('<', '|'),
('>', '|'),
('=', '|'),
('|', '|')]:
with self.assertRaisesRegex(ValueError,
"Unrecognised byte order indicator"):
utils.byte_orders_equal(*pair)
def test_unknown_byte_order_raises_exception(self):
with self.assertRaisesRegex(ValueError, "Unrecognised byte order indicator"):
utils.machine_stamp_from_byte_order('|')
def test_spacegroup_is_volume_stack(self):
for ispg in range(-2000, 2000):
assert utils.spacegroup_is_volume_stack(ispg) == (401 <= ispg <= 630)
def test_pretty_machine_stamp(self):
machst = utils.machine_stamp_from_byte_order('<')
assert utils.pretty_machine_stamp(machst) == "0x44 0x44 0x00 0x00"
def test_is_printable_ascii_with_printable_string(self):
assert utils.is_printable_ascii('Letters + digits012359 + punctuation*&^%$!#')
def test_is_printable_ascii_rejects_newline(self):
assert not utils.is_printable_ascii('\n')
def test_is_printable_ascii_rejects_tab(self):
assert not utils.is_printable_ascii('\t')
def test_is_printable_ascii_rejects_null_byte(self):
assert not utils.is_printable_ascii('\x00')
def test_is_printable_ascii_rejects_other_unprintable_bytes(self):
# Try a few others; not comprehensive.
assert not utils.is_printable_ascii('\x01')
assert not utils.is_printable_ascii('\x02')
assert not utils.is_printable_ascii('\x03')
def test_is_printable_ascii_rejects_non_ascii_printable_character(self):
assert not utils.is_printable_ascii('£')
def test_printable_string_from_bytes_leaves_ascii_unchanged(self):
val = b'Letters + digits012359 + punctuation*&^%$!#'
result = utils.printable_string_from_bytes(val)
assert result == 'Letters + digits012359 + punctuation*&^%$!#'
def test_printable_string_from_bytes_strips_unprintable_characters(self):
val = b'Test \n non-printable string \t \x01\x00'
assert utils.printable_string_from_bytes(val) == 'Test non-printable string '
def test_printable_string_from_bytes_strips_non_ascii_characters(self):
val = b'Test non-ASCII string \xa3'
assert utils.printable_string_from_bytes(val) == 'Test non-ASCII string '
def test_bytes_from_string_with_ascii_string(self):
assert utils.bytes_from_string('ASCII string 123#!') == b'ASCII string 123#!'
def test_bytes_from_string_with_non_ascii_string_raises_exception(self):
with self.assertRaises(UnicodeError):
utils.bytes_from_string('Non-ASCII string £')
def test_bytes_from_string_with_unicode_string(self):
# To make sure things work properly in Python 2
assert utils.bytes_from_string(u'Unicode string') == b'Unicode string'
def test_bytes_from_string_with_unicode_non_ascii_string_raises_exception(self):
# To make sure things work properly in Python 2
with self.assertRaises(UnicodeError):
assert utils.bytes_from_string(u'Unicode non-ASCII £')
if __name__ == '__main__':
unittest.main()
|
