File: test_cuneiform.py

package info (click to toggle)
python-pyocr 0.8.5-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 548 kB
  • sloc: python: 4,921; makefile: 90; sh: 3
file content (306 lines) | stat: -rw-r--r-- 12,004 bytes parent folder | download
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
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
import subprocess

from io import StringIO
from unittest.mock import patch, MagicMock

from PIL import Image

from pyocr import builders
from pyocr import cuneiform

from .test_base import BaseTest


class TestCuneiform(BaseTest):
    """
    These tests make sure the requirements for the tests are met.
    """

    @patch("shutil.which")
    def test_available(self, which):
        # XXX is it useful?
        which.return_value = True
        self.assertTrue(cuneiform.is_available())
        which.assert_called_once_with("cuneiform")

    @patch("subprocess.Popen")
    def test_version(self, popen):
        stdout = MagicMock()
        stdout.stdout.read.return_value = (
            b"Cuneiform for Linux 1.1.0\n"
            b"Usage: cuneiform [-l languagename -f format --dotmatrix --fax"
            b" --singlecolumn -o result_file] imagefile"
        )
        popen.return_value = stdout
        self.assertSequenceEqual(cuneiform.get_version(), (1, 1, 0))

    @patch("subprocess.Popen")
    def test_version_error(self, popen):
        stdout = MagicMock()
        stdout.stdout.read.return_value = b"\n"
        popen.return_value = stdout
        self.assertIsNone(cuneiform.get_version())

    @patch("subprocess.Popen")
    def test_langs(self, popen):
        stdout = MagicMock()
        stdout.stdout.read.return_value = (
            b"Cuneiform for Linux 1.1.0\n"
            b"Supported languages: eng ger fra rus swe spa ita ruseng ukr srp "
            b"hrv pol dan por dut cze rum hun bul slv lav lit est tur."
        )
        popen.return_value = stdout
        langs = cuneiform.get_available_languages()
        self.assertIn("eng", langs)
        self.assertIn("fra", langs)
        popen.assert_called_once_with(
            ["cuneiform", "-l"],
            stdout=subprocess.PIPE, stderr=subprocess.STDOUT
        )

    def test_name(self):
        self.assertEqual(cuneiform.get_name(), "Cuneiform (sh)")

    def test_can_detect_orientation(self):
        self.assertFalse(cuneiform.can_detect_orientation())

    def test_available_builders(self):
        self.assertListEqual(
            cuneiform.get_available_builders(),
            [
                builders.TextBuilder,
                builders.WordBoxBuilder,
                builders.LineBoxBuilder,
            ]
        )


class TestCuneiformTxt(BaseTest):
    """
    These tests make sure the "usual" OCR works fine. (the one generating
    a .txt file)
    """
    @patch("pyocr.tesseract.get_version")
    def setUp(self, get_version):
        super().setUp()
        get_version.return_value = (4, 0, 0)
        self.builder = builders.TextBuilder()
        self.image = Image.new(mode="RGB", size=(1, 1))
        self.text_file = StringIO(self._get_file_content("text"))
        self.stdout = MagicMock()
        self.stdout.stdout.read.return_value = b"Cuneiform for Linux 1.1.0\n"
        self.stdout.wait.return_value = 0
        self.tmp_filename = "/tmp/cuneiform_n0qfk87otxt"
        self.enter = MagicMock()
        self.enter.__enter__.return_value = MagicMock()
        self.enter.__enter__.return_value.configure_mock(
            name=self.tmp_filename
        )

    @patch("pyocr.tesseract.get_version")
    @patch("pyocr.cuneiform.temp_file")
    @patch("codecs.open")
    @patch("subprocess.Popen")
    def test_image_to_string_defaults_to_text_buidler(self, popen, copen,
                                                      temp_file, get_version):
        get_version.return_value = (4, 0, 0)
        popen.return_value = self.stdout
        copen.return_value = self.text_file
        temp_file.return_value = self.enter
        output = cuneiform.image_to_string(self.image)
        self.assertEqual(output, self._get_file_content("text").strip())
        popen.assert_called_once_with(
            ["cuneiform", "-f", "text", "-o", self.tmp_filename, "-"],
            stdin=subprocess.PIPE, stdout=subprocess.PIPE,
            stderr=subprocess.STDOUT
        )

    @patch("pyocr.cuneiform.temp_file")
    @patch("codecs.open")
    @patch("subprocess.Popen")
    def test_lang(self, popen, copen, temp_file):
        popen.return_value = self.stdout
        copen.return_value = self.text_file
        temp_file.return_value = self.enter
        output = cuneiform.image_to_string(self.image, lang="fra",
                                           builder=self.builder)
        self.assertEqual(output, self._get_file_content("text").strip())
        popen.assert_called_once_with(
            ["cuneiform", "-l", "fra", "-f", "text", "-o", self.tmp_filename,
             "-"],
            stdin=subprocess.PIPE, stdout=subprocess.PIPE,
            stderr=subprocess.STDOUT
        )

    @patch("pyocr.cuneiform.temp_file")
    @patch("codecs.open")
    @patch("subprocess.Popen")
    def test_text(self, popen, copen, temp_file):
        popen.return_value = self.stdout
        copen.return_value = self.text_file
        temp_file.return_value = self.enter
        output = cuneiform.image_to_string(self.image,
                                           builder=self.builder)
        self.assertEqual(output, self._get_file_content("text").strip())
        popen.assert_called_once_with(
            ["cuneiform", "-f", "text", "-o", self.tmp_filename, "-"],
            stdin=subprocess.PIPE, stdout=subprocess.PIPE,
            stderr=subprocess.STDOUT
        )

    @patch("subprocess.Popen")
    def test_text_error(self, popen):
        message = ("Cuneiform for Linux 1.1.0\n"
                   "Magick: Improper image header (example.png) reported by "
                   "coders/png.c:2932 (ReadPNGImage)\n")
        self.stdout.stdout.read.return_value = message.encode()
        self.stdout.wait.return_value = 1
        popen.return_value = self.stdout
        with self.assertRaises(cuneiform.CuneiformError) as ce:
            cuneiform.image_to_string(self.image, builder=self.builder)
        self.assertEqual(ce.exception.status, 1)
        self.assertEqual(ce.exception.message, message)

    @patch("pyocr.cuneiform.temp_file")
    @patch("codecs.open")
    @patch("subprocess.Popen")
    def test_text_non_rgb_image(self, popen, copen, temp_file):
        """This tests that image_to_string works with non RGB mode images and
        that image is converted in function."""
        image = self.image.convert("L")
        popen.return_value = self.stdout
        copen.return_value = self.text_file
        temp_file.return_value = self.enter
        output = cuneiform.image_to_string(image, builder=self.builder)
        self.assertEqual(output, self._get_file_content("text").strip())
        popen.assert_called_once_with(
            ["cuneiform", "-f", "text", "-o", self.tmp_filename, "-"],
            stdin=subprocess.PIPE, stdout=subprocess.PIPE,
            stderr=subprocess.STDOUT
        )


class TestCuneiformDigits(BaseTest):

    @patch("pyocr.tesseract.get_version")
    def setUp(self, get_version):
        super().setUp()
        get_version.return_value = (4, 0, 0)
        self.builder = builders.DigitBuilder()
        self.image = Image.new(mode="RGB", size=(1, 1))

    def test_digits_not_implemented(self):
        with self.assertRaises(NotImplementedError):
            cuneiform.image_to_string(self.image, builder=self.builder)

    def test_digits_box_not_implemented(self):
        with self.assertRaises(NotImplementedError):
            cuneiform.image_to_string(self.image,
                                      builder=self.builder)


class TestCuneiformWordBox(BaseTest):
    """
    These tests make sure that cuneiform box handling works fine.
    """
    @patch("pyocr.tesseract.get_version")
    def setUp(self, get_version):
        super().setUp()
        get_version.return_value = (4, 0, 0)
        self.builder = builders.WordBoxBuilder()
        self.image = Image.new(mode="RGB", size=(1, 1))
        self.text_file = StringIO(self._get_file_content("cuneiform.words"))
        self.stdout = MagicMock()
        self.stdout.stdout.read.return_value = b"Cuneiform for Linux 1.1.0\n"
        self.stdout.wait.return_value = 0
        self.tmp_filename = "/tmp/cuneiform_n0qfk87otxt"
        self.enter = MagicMock()
        self.enter.__enter__.return_value = MagicMock()
        self.enter.__enter__.return_value.configure_mock(
            name=self.tmp_filename
        )

    @patch("pyocr.cuneiform.temp_file")
    @patch("codecs.open")
    @patch("subprocess.Popen")
    def test_word(self, popen, copen, temp_file):
        popen.return_value = self.stdout
        copen.return_value = self.text_file
        temp_file.return_value = self.enter
        output = cuneiform.image_to_string(self.image,
                                           builder=self.builder)
        popen.assert_called_once_with(
            ["cuneiform", "-f", "hocr", "-o", self.tmp_filename, "-"],
            stdin=subprocess.PIPE, stdout=subprocess.PIPE,
            stderr=subprocess.STDOUT
        )
        for box in output:
            self.assertIsInstance(box, builders.Box)

    @patch("subprocess.Popen")
    def test_word_error(self, popen):
        stdout = MagicMock()
        message = ("Cuneiform for Linux 1.1.0\n"
                   "Magick: Improper image header (example.png) reported by "
                   "coders/png.c:2932 (ReadPNGImage)\n")
        stdout.stdout.read.return_value = message.encode()
        stdout.wait.return_value = 1
        popen.return_value = stdout
        with self.assertRaises(cuneiform.CuneiformError) as ce:
            cuneiform.image_to_string(self.image,
                                      builder=self.builder)
        self.assertEqual(ce.exception.status, 1)
        self.assertEqual(ce.exception.message, message)


class TestCuneiformLineBox(BaseTest):
    """
    These tests make sure that cuneiform box handling works fine.
    """
    @patch("pyocr.tesseract.get_version")
    def setUp(self, get_version):
        super().setUp()
        get_version.return_value = (4, 0, 0)
        self.builder = builders.LineBoxBuilder()
        self.image = Image.new(mode="RGB", size=(1, 1))
        self.text_file = StringIO(self._get_file_content("cuneiform.lines"))
        self.stdout = MagicMock()
        self.stdout.stdout.read.return_value = b"Cuneiform for Linux 1.1.0\n"
        self.stdout.wait.return_value = 0
        self.tmp_filename = "/tmp/cuneiform_n0qfk87otxt"
        self.enter = MagicMock()
        self.enter.__enter__.return_value = MagicMock()
        self.enter.__enter__.return_value.configure_mock(
            name=self.tmp_filename
        )

    @patch("pyocr.cuneiform.temp_file")
    @patch("codecs.open")
    @patch("subprocess.Popen")
    def test_line(self, popen, copen, temp_file):
        popen.return_value = self.stdout
        copen.return_value = self.text_file
        temp_file.return_value = self.enter
        output = cuneiform.image_to_string(self.image,
                                           builder=self.builder)
        popen.assert_called_once_with(
            ["cuneiform", "-f", "hocr", "-o", self.tmp_filename, "-"],
            stdin=subprocess.PIPE, stdout=subprocess.PIPE,
            stderr=subprocess.STDOUT
        )
        for box in output:
            self.assertIsInstance(box, builders.LineBox)

    @patch("subprocess.Popen")
    def test_line_error(self, popen):
        message = ("Cuneiform for Linux 1.1.0\n"
                   "Magick: Improper image header (example.png) reported by "
                   "coders/png.c:2932 (ReadPNGImage)\n")
        self.stdout.stdout.read.return_value = message.encode()
        self.stdout.wait.return_value = 1
        popen.return_value = self.stdout
        with self.assertRaises(cuneiform.CuneiformError) as ce:
            cuneiform.image_to_string(self.image,
                                      builder=self.builder)
        self.assertEqual(ce.exception.status, 1)
        self.assertEqual(ce.exception.message, message)