dataset.py 10.9 KB
Newer Older
1
import os
2
from abc import ABC, abstractmethod
3
from typing import Callable, Iterator
4
5

import fitz
6
from loguru import logger
7
8
9
10

from magic_pdf.config.enums import SupportedPdfParseMethod
from magic_pdf.data.schemas import PageInfo
from magic_pdf.data.utils import fitz_doc_to_image
11
from magic_pdf.filter import classify
12
from magic_pdf.model.sub_modules.language_detection.utils import auto_detect_lang
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34


class PageableData(ABC):
    @abstractmethod
    def get_image(self) -> dict:
        """Transform data to image."""
        pass

    @abstractmethod
    def get_doc(self) -> fitz.Page:
        """Get the pymudoc page."""
        pass

    @abstractmethod
    def get_page_info(self) -> PageInfo:
        """Get the page info of the page.

        Returns:
            PageInfo: the page info of this page
        """
        pass

35
36
    @abstractmethod
    def draw_rect(self, rect_coords, color, fill, fill_opacity, width, overlay):
icecraft's avatar
icecraft committed
37
38
39
40
        """draw rectangle.

        Args:
            rect_coords (list[float]): four elements array contain the top-left and bottom-right coordinates, [x0, y0, x1, y1]
xu rui's avatar
xu rui committed
41
            color (list[float] | None): three element tuple which describe the RGB of the board line, None means no board line
icecraft's avatar
icecraft committed
42
43
44
45
46
            fill (list[float] | None): fill the board with RGB, None means will not fill with color
            fill_opacity (float): opacity of the fill, range from [0, 1]
            width (float): the width of board
            overlay (bool): fill the color in foreground or background. True means fill in background.
        """
47
48
49
50
        pass

    @abstractmethod
    def insert_text(self, coord, content, fontsize, color):
icecraft's avatar
icecraft committed
51
52
53
54
55
56
        """insert text.

        Args:
            coord (list[float]): four elements array contain the top-left and bottom-right coordinates, [x0, y0, x1, y1]
            content (str): the text content
            fontsize (int): font size of the text
xu rui's avatar
xu rui committed
57
            color (list[float] | None):  three element tuple which describe the RGB of the board line, None will use the default font color!
icecraft's avatar
icecraft committed
58
        """
59
60
        pass

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

class Dataset(ABC):
    @abstractmethod
    def __len__(self) -> int:
        """The length of the dataset."""
        pass

    @abstractmethod
    def __iter__(self) -> Iterator[PageableData]:
        """Yield the page data."""
        pass

    @abstractmethod
    def supported_methods(self) -> list[SupportedPdfParseMethod]:
        """The methods that this dataset support.

        Returns:
            list[SupportedPdfParseMethod]: The supported methods, Valid methods are: OCR, TXT
        """
        pass

    @abstractmethod
    def data_bits(self) -> bytes:
        """The bits used to create this dataset."""
        pass

    @abstractmethod
    def get_page(self, page_id: int) -> PageableData:
        """Get the page indexed by page_id.

        Args:
            page_id (int): the index of the page

        Returns:
            PageableData: the page doc object
        """
        pass

99
100
    @abstractmethod
    def dump_to_file(self, file_path: str):
xu rui's avatar
xu rui committed
101
102
103
104
105
        """Dump the file

        Args: 
            file_path (str): the file path 
        """
106
107
108
109
        pass

    @abstractmethod
    def apply(self, proc: Callable, *args, **kwargs):
xu rui's avatar
xu rui committed
110
111
112
113
        """Apply callable method which.

        Args:
            proc (Callable): invoke proc as follows:
xu rui's avatar
xu rui committed
114
                proc(self, *args, **kwargs)
xu rui's avatar
xu rui committed
115
116
117
118

        Returns:
            Any: return the result generated by proc
        """
119
120
121
122
        pass

    @abstractmethod
    def classify(self) -> SupportedPdfParseMethod:
xu rui's avatar
xu rui committed
123
124
125
126
127
128
129
130
131
132
133
        """classify the dataset 

        Returns:
            SupportedPdfParseMethod: _description_
        """
        pass

    @abstractmethod
    def clone(self):
        """clone this dataset
        """
134
135
        pass

136
137

class PymuDocDataset(Dataset):
138
    def __init__(self, bits: bytes, lang=None):
139
140
141
142
143
        """Initialize the dataset, which wraps the pymudoc documents.

        Args:
            bits (bytes): the bytes of the pdf
        """
144
145
        self._raw_fitz = fitz.open('pdf', bits)
        self._records = [Doc(v) for v in self._raw_fitz]
146
147
148
        self._data_bits = bits
        self._raw_data = bits

149
150
151
152
153
154
155
        if lang == '':
            self._lang = None
        elif lang == 'auto':
            self._lang = auto_detect_lang(bits)
            logger.info(f"lang: {lang}, detect_lang: {self._lang}")
        else:
            self._lang = lang
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
    def __len__(self) -> int:
        """The page number of the pdf."""
        return len(self._records)

    def __iter__(self) -> Iterator[PageableData]:
        """Yield the page doc object."""
        return iter(self._records)

    def supported_methods(self) -> list[SupportedPdfParseMethod]:
        """The method supported by this dataset.

        Returns:
            list[SupportedPdfParseMethod]: the supported methods
        """
        return [SupportedPdfParseMethod.OCR, SupportedPdfParseMethod.TXT]

    def data_bits(self) -> bytes:
        """The pdf bits used to create this dataset."""
        return self._data_bits

    def get_page(self, page_id: int) -> PageableData:
        """The page doc object.

        Args:
            page_id (int): the page doc index

        Returns:
            PageableData: the page doc object
        """
        return self._records[page_id]

187
    def dump_to_file(self, file_path: str):
xu rui's avatar
xu rui committed
188
189
190
191
192
193
        """Dump the file

        Args: 
            file_path (str): the file path 
        """
        
194
195
196
197
198
199
        dir_name = os.path.dirname(file_path)
        if dir_name not in ('', '.', '..'):
            os.makedirs(dir_name, exist_ok=True)
        self._raw_fitz.save(file_path)

    def apply(self, proc: Callable, *args, **kwargs):
xu rui's avatar
xu rui committed
200
201
202
203
204
205
206
207
208
        """Apply callable method which.

        Args:
            proc (Callable): invoke proc as follows:
                proc(dataset, *args, **kwargs)

        Returns:
            Any: return the result generated by proc
        """
209
210
        if 'lang' in kwargs and self._lang is not None:
            kwargs['lang'] = self._lang
xu rui's avatar
xu rui committed
211
        return proc(self, *args, **kwargs)
212
213

    def classify(self) -> SupportedPdfParseMethod:
xu rui's avatar
xu rui committed
214
215
216
217
218
        """classify the dataset 

        Returns:
            SupportedPdfParseMethod: _description_
        """
219
220
        return classify(self._data_bits)

xu rui's avatar
xu rui committed
221
222
223
224
225
    def clone(self):
        """clone this dataset
        """
        return PymuDocDataset(self._raw_data)

226
227
228
229
230
231
232
233
234

class ImageDataset(Dataset):
    def __init__(self, bits: bytes):
        """Initialize the dataset, which wraps the pymudoc documents.

        Args:
            bits (bytes): the bytes of the photo which will be converted to pdf first. then converted to pymudoc.
        """
        pdf_bytes = fitz.open(stream=bits).convert_to_pdf()
235
236
        self._raw_fitz = fitz.open('pdf', pdf_bytes)
        self._records = [Doc(v) for v in self._raw_fitz]
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
        self._raw_data = bits
        self._data_bits = pdf_bytes

    def __len__(self) -> int:
        """The length of the dataset."""
        return len(self._records)

    def __iter__(self) -> Iterator[PageableData]:
        """Yield the page object."""
        return iter(self._records)

    def supported_methods(self):
        """The method supported by this dataset.

        Returns:
            list[SupportedPdfParseMethod]: the supported methods
        """
        return [SupportedPdfParseMethod.OCR]

    def data_bits(self) -> bytes:
        """The pdf bits used to create this dataset."""
        return self._data_bits

    def get_page(self, page_id: int) -> PageableData:
        """The page doc object.

        Args:
            page_id (int): the page doc index

        Returns:
            PageableData: the page doc object
        """
        return self._records[page_id]

271
    def dump_to_file(self, file_path: str):
xu rui's avatar
xu rui committed
272
273
274
275
276
        """Dump the file

        Args: 
            file_path (str): the file path 
        """
277
278
279
280
281
282
        dir_name = os.path.dirname(file_path)
        if dir_name not in ('', '.', '..'):
            os.makedirs(dir_name, exist_ok=True)
        self._raw_fitz.save(file_path)

    def apply(self, proc: Callable, *args, **kwargs):
xu rui's avatar
xu rui committed
283
284
285
286
287
288
289
290
291
        """Apply callable method which.

        Args:
            proc (Callable): invoke proc as follows:
                proc(dataset, *args, **kwargs)

        Returns:
            Any: return the result generated by proc
        """
292
293
294
        return proc(self, *args, **kwargs)

    def classify(self) -> SupportedPdfParseMethod:
xu rui's avatar
xu rui committed
295
296
297
298
299
        """classify the dataset 

        Returns:
            SupportedPdfParseMethod: _description_
        """
300
301
        return SupportedPdfParseMethod.OCR

xu rui's avatar
xu rui committed
302
303
304
305
    def clone(self):
        """clone this dataset
        """
        return ImageDataset(self._raw_data)
306
307
308

class Doc(PageableData):
    """Initialized with pymudoc object."""
309

310
311
312
313
    def __init__(self, doc: fitz.Page):
        self._doc = doc

    def get_image(self):
xu rui's avatar
xu rui committed
314
        """Return the image info.
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345

        Returns:
            dict: {
                img: np.ndarray,
                width: int,
                height: int
            }
        """
        return fitz_doc_to_image(self._doc)

    def get_doc(self) -> fitz.Page:
        """Get the pymudoc object.

        Returns:
            fitz.Page: the pymudoc object
        """
        return self._doc

    def get_page_info(self) -> PageInfo:
        """Get the page info of the page.

        Returns:
            PageInfo: the page info of this page
        """
        page_w = self._doc.rect.width
        page_h = self._doc.rect.height
        return PageInfo(w=page_w, h=page_h)

    def __getattr__(self, name):
        if hasattr(self._doc, name):
            return getattr(self._doc, name)
346
347

    def draw_rect(self, rect_coords, color, fill, fill_opacity, width, overlay):
icecraft's avatar
icecraft committed
348
349
350
351
        """draw rectangle.

        Args:
            rect_coords (list[float]): four elements array contain the top-left and bottom-right coordinates, [x0, y0, x1, y1]
xu rui's avatar
xu rui committed
352
            color (list[float] | None): three element tuple which describe the RGB of the board line, None means no board line
icecraft's avatar
icecraft committed
353
354
355
356
357
            fill (list[float] | None): fill the board with RGB, None means will not fill with color
            fill_opacity (float): opacity of the fill, range from [0, 1]
            width (float): the width of board
            overlay (bool): fill the color in foreground or background. True means fill in background.
        """
358
359
360
361
362
363
364
365
366
367
        self._doc.draw_rect(
            rect_coords,
            color=color,
            fill=fill,
            fill_opacity=fill_opacity,
            width=width,
            overlay=overlay,
        )

    def insert_text(self, coord, content, fontsize, color):
icecraft's avatar
icecraft committed
368
369
370
371
372
373
        """insert text.

        Args:
            coord (list[float]): four elements array contain the top-left and bottom-right coordinates, [x0, y0, x1, y1]
            content (str): the text content
            fontsize (int): font size of the text
xu rui's avatar
xu rui committed
374
            color (list[float] | None):  three element tuple which describe the RGB of the board line, None will use the default font color!
icecraft's avatar
icecraft committed
375
        """
376
        self._doc.insert_text(coord, content, fontsize=fontsize, color=color)