mineru 0.5.0

Rust client, CLI, and API server for OpenAI-compatible MinerU document parsing
Documentation
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
307
308
309
310
311
312
313
314
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
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
"""Project-owned adapter for the pinned MinerU 4.2.3 parser.

This is not an official MinerU worker protocol.  Rust supplies one JSON request
on stdin and owns the process lifetime; this shim only imports MinerU, invokes
parse_async, and writes the official result files.
"""

import asyncio
import contextlib
import importlib.metadata
import json
import os
from pathlib import Path
import sys
import tempfile
from typing import Iterable, Union


from mineru_official_worker_contract import BUNDLE_NAME, DIAGNOSTIC_CAP, PACKAGE_VERSION, PROTOCOL, PROTOCOL_CAP, LimitError
from mineru_official_worker_protocol import (
    BoundedCapture, WORKER_SOURCE_CONTRACT, _bounded_text, _document_env,
    _document_parse_kwargs, _emit, _persistent_main, _response, _validate_document_request,
)
from mineru_official_worker_bundle import (
    rewrite_markdown_image_references,
    rewrite_reference_tokens,
    rewrite_typed_json_references,
)


MAX_BUNDLE_ENTRIES = 8_192
MAX_BUNDLE_PATH_DEPTH = 32
MAX_BUNDLE_COMPONENT_BYTES = 255
MAX_BUNDLE_PATH_BYTES = 4_096
MAX_BUNDLE_NAME_BUDGET = 32 * 1024 * 1024
MAX_TEXT_JSON_BYTES = 64 * 1024 * 1024


def _read_bounded(path: Path, limit: int) -> bytes:
    if path.stat().st_size > limit:
        raise LimitError("official text or JSON file exceeds its limit")
    chunks: list[bytes] = []
    total = 0
    with path.open("rb") as source:
        while True:
            chunk = source.read(min(64 * 1024, limit - total + 1))
            if not chunk:
                return b"".join(chunks)
            total += len(chunk)
            if total > limit:
                raise LimitError("official text or JSON file exceeds its limit")
            chunks.append(chunk)


class BundleWriter:
    _FIXED_FILES = frozenset(
        {"markdown.md", "middle_json.json", "structured_content.json", "model_output.json", "operation.json", "render.json", "render.bin"}
    )
    # Only these files carry image references worth rewriting; content_list
    # is no longer produced upstream and model_output is left untouched.
    _REWRITE_FILES = frozenset({"markdown.md", "middle_json.json", "structured_content.json"})

    def __init__(self, root: Path, limit: int, *, typed_references: bool = False) -> None:
        if isinstance(limit, bool) or not isinstance(limit, int) or limit <= 0:
            raise LimitError("bundle byte limit must be positive")
        self.root = root
        self.root.mkdir(parents=True, exist_ok=True)
        self.limit = limit
        self._text_json_limit = min(limit, MAX_TEXT_JSON_BYTES)
        self.total = 0
        self._sizes: dict[str, int] = {}
        self._text_paths: set[str] = set()
        self._image_aliases: dict[str, str] = {}
        self._image_alias_keys: dict[str, str] = {}
        self._directories: set[str] = set()
        self._files: set[str] = set()
        self._directory_names: dict[str, str] = {}
        self._file_names: dict[str, str] = {}
        self._name_bytes = 0
        self._alias_bytes = 0
        self._typed_references = typed_references

    def _name(self, name: object) -> str:
        if not isinstance(name, (str, bytes, os.PathLike)):
            raise ValueError("unsafe bundle path")
        try:
            raw = os.fspath(name)
        except TypeError as error:
            raise ValueError("unsafe bundle path") from error
        if isinstance(raw, bytes):
            if len(raw) > MAX_BUNDLE_PATH_BYTES:
                raise LimitError("bundle path exceeds its byte limit")
            try:
                raw = raw.decode("utf-8")
            except UnicodeDecodeError as error:
                raise ValueError("unsafe bundle path") from error
        if not isinstance(raw, str) or "\\" in raw:
            raise ValueError("unsafe bundle path")
        if not raw:
            raise ValueError("bundle path must be relative")
        try:
            raw_bytes = raw.encode("utf-8")
        except UnicodeEncodeError as error:
            raise ValueError("unsafe bundle path") from error
        if len(raw_bytes) > MAX_BUNDLE_PATH_BYTES:
            raise LimitError("bundle path exceeds its byte limit")
        if len(raw) >= 2 and raw[0].isalpha() and raw[1] == ":":
            raise ValueError("unsafe bundle path")
        parts = raw.split("/")
        if len(parts) > MAX_BUNDLE_PATH_DEPTH:
            raise LimitError("bundle path is too deep")
        if not parts or parts[0] == "":
            raise ValueError("bundle path must be relative")
        if any(not _portable_name(part) for part in parts):
            raise ValueError("unsafe bundle path")
        if parts[0] == "images":
            if len(parts) < 2:
                raise ValueError("images must contain a file")
            relative_parts = parts
        elif raw in self._FIXED_FILES:
            relative_parts = parts
        elif len(parts) == 1:
            relative_parts = ["images", parts[0]]
        else:
            raise ValueError("unknown official bundle path")
        if len(relative_parts) > MAX_BUNDLE_PATH_DEPTH:
            raise LimitError("bundle path is too deep")
        component_bytes = []
        for part in relative_parts:
            try:
                size = len(part.encode("utf-8"))
            except UnicodeEncodeError as error:
                raise ValueError("unsafe bundle path") from error
            if size > MAX_BUNDLE_COMPONENT_BYTES:
                raise LimitError("bundle path component exceeds its byte limit")
            component_bytes.append(size)
        path_bytes = sum(component_bytes) + len(relative_parts) - 1
        if path_bytes > MAX_BUNDLE_PATH_BYTES:
            raise LimitError("bundle path exceeds its byte limit")
        return "/".join(relative_parts)

    def _path(self, name: object) -> Path:
        relative = self._name(name)
        return self.root.joinpath(*relative.split("/"))

    def _reserve_path(self, relative: str) -> tuple[tuple[str, ...], bool]:
        parts = relative.split("/")
        parents = tuple("/".join(parts[:index]) for index in range(1, len(parts)))
        for parent in parents:
            key = _lowercase_key(parent)
            if key in self._files:
                raise ValueError("bundle path conflicts with a file")
            if key in self._directories and self._directory_names.get(key, parent) != parent:
                raise ValueError("bundle path collides with a directory")
        relative_key = _lowercase_key(relative)
        if relative_key in self._directories:
            raise ValueError("bundle path conflicts with a directory")
        if (
            relative_key in self._files
            and self._file_names.get(relative_key, relative) != relative
        ):
            raise ValueError("bundle path collides with a file")
        new_directories = tuple(
            parent for parent in parents if _lowercase_key(parent) not in self._directories
        )
        new_file = relative_key not in self._files
        additions = len(new_directories) + int(new_file)
        if len(self._directories) + len(self._files) + additions > MAX_BUNDLE_ENTRIES:
            raise LimitError("official bundle has too many files or directories")
        added_name_bytes = sum(len(name.encode("utf-8")) for name in new_directories)
        if new_file:
            added_name_bytes += len(relative.encode("utf-8"))
        if self._name_bytes + added_name_bytes > MAX_BUNDLE_NAME_BUDGET:
            raise LimitError("official bundle relative-name budget exceeded")
        for directory in new_directories:
            key = _lowercase_key(directory)
            self._directories.add(key)
            self._directory_names[key] = directory
        if new_file:
            self._files.add(relative_key)
            self._file_names[relative_key] = relative
        self._name_bytes += added_name_bytes
        return new_directories, new_file

    def _release_path(self, reservation: tuple[tuple[str, ...], bool], relative: str) -> None:
        new_directories, new_file = reservation
        for directory in new_directories:
            key = _lowercase_key(directory)
            self._directories.remove(key)
            self._directory_names.pop(key, None)
            self._name_bytes -= len(directory.encode("utf-8"))
        if new_file:
            key = _lowercase_key(relative)
            self._files.remove(key)
            self._file_names.pop(key, None)
            self._name_bytes -= len(relative.encode("utf-8"))

    def _image_alias(self, relative: str) -> tuple[str, str] | None:
        image_name = relative.removeprefix("images/")
        if "/" not in image_name:
            return image_name, relative
        return None

    def _check_alias(self, alias: tuple[str, str] | None) -> None:
        if alias is None:
            return
        key = _lowercase_key(alias[0])
        if key in self._image_alias_keys:
            if self._image_alias_keys[key] != alias[0]:
                raise ValueError("bundle image alias collision")
            return
        if max(len(self._image_alias_keys), len(self._image_aliases)) >= MAX_BUNDLE_ENTRIES:
            raise LimitError("official bundle has too many image aliases")
        size = len(alias[0].encode("utf-8")) + len(alias[1].encode("utf-8"))
        if self._alias_bytes + size > MAX_BUNDLE_NAME_BUDGET:
            raise LimitError("official bundle image-alias budget exceeded")

    def _write_raw(self, relative: str, chunks: Iterable[Union[bytes, str]]) -> None:
        path = self.root.joinpath(*relative.split("/"))
        path.parent.mkdir(parents=True, exist_ok=True)
        old_size = self._sizes.get(relative, 0)
        if relative not in self._sizes and len(self._sizes) >= MAX_BUNDLE_ENTRIES:
            raise LimitError("official bundle has too many files")
        if old_size < 0 or old_size > self.total:
            raise LimitError("official bundle accounting is inconsistent")
        base_total = self.total - old_size
        if base_total > self.limit:
            raise LimitError("official bundle accounting exceeds its byte limit")
        file_limit = self._text_json_limit if relative in self._FIXED_FILES else None
        descriptor = None
        temporary: Path | None = None
        size = 0
        try:
            descriptor, temporary_name = tempfile.mkstemp(
                prefix=f".{path.name}.", suffix=".tmp", dir=str(path.parent)
            )
            temporary = Path(temporary_name)
            with os.fdopen(descriptor, "wb") as output:
                descriptor = None
                for chunk in chunks:  # type: ignore[union-attr]
                    if isinstance(chunk, str):
                        chunk = chunk.encode("utf-8")
                    if not isinstance(chunk, (bytes, bytearray, memoryview)):
                        raise TypeError("bundle writer received non-bytes")
                    chunk = bytes(chunk)
                    next_size = size + len(chunk)
                    if base_total + next_size > self.limit:
                        raise LimitError("official bundle exceeds configured byte limit")
                    if file_limit is not None and next_size > file_limit:
                        raise LimitError("official text or JSON file exceeds its limit")
                    output.write(chunk)
                    size = next_size
            os.replace(temporary, path)
            self.total = base_total + size
            self._sizes[relative] = size
        finally:
            if descriptor is not None:
                os.close(descriptor)
            if temporary is not None:
                try:
                    temporary.unlink()
                except FileNotFoundError:
                    pass

    def _write(self, name: object, chunks: Iterable[Union[bytes, str]]) -> None:
        relative = self._name(name)
        alias = self._image_alias(relative)
        self._check_alias(alias)
        reservation = self._reserve_path(relative)
        try:
            self._write_raw(relative, chunks)
        except Exception:
            self._release_path(reservation, relative)
            raise
        if relative in self._REWRITE_FILES:
            self._text_paths.add(relative)
            self._rewrite_text((relative,))
        else:
            self._record_image(relative)
            self._rewrite_text(self._text_paths)

    def _record_image(self, relative: str) -> None:
        alias = self._image_alias(relative)
        if alias is None:
            return
        key = _lowercase_key(alias[0])
        if key in self._image_alias_keys:
            return
        self._image_aliases[alias[0]] = alias[1]
        self._image_alias_keys[key] = alias[0]
        self._alias_bytes += len(alias[0].encode("utf-8")) + len(alias[1].encode("utf-8"))

    def _rewrite_text(self, relatives: Iterable[str]) -> None:
        for relative in relatives:
            path = self.root.joinpath(*relative.split("/"))
            try:
                original = _read_bounded(path, self._text_json_limit)
            except OSError:
                continue
            rewritten = self._rewrite_text_bytes(relative, original)
            if rewritten != original:
                self._write_raw(relative, (rewritten,))

    def _rewrite_text_bytes(self, relative: str, value: bytes) -> bytes:
        if len(value) > self._text_json_limit:
            raise LimitError("official text or JSON file exceeds its limit")
        try:
            text = value.decode("utf-8")
        except UnicodeDecodeError:
            return value
        if relative == "markdown.md":
            rewritten = (
                rewrite_markdown_image_references(text, self._image_aliases)
                if self._typed_references
                else rewrite_reference_tokens(text, self._image_aliases)
            )
        else:
            if self._typed_references:
                rewritten = rewrite_typed_json_references(text, self._image_aliases, self._text_json_limit)
            else:
                rewritten = _rewrite_json_references(text, self._image_aliases, self._text_json_limit)
        encoded = rewritten.encode("utf-8")
        if len(encoded) > self._text_json_limit:
            raise LimitError("official text or JSON file exceeds its limit")
        return encoded

    def _arguments(self, first: object, second: object) -> tuple[object, object]:
        try:
            self._name(first)
            return first, second
        except (TypeError, ValueError):
            self._name(second)
            return second, first

    def write(self, first: object, second: object) -> None:
        name, value = self._arguments(first, second)
        if isinstance(value, str):
            self.write_string(name, value)
        elif isinstance(value, (bytes, bytearray, memoryview)):
            self._write(name, (bytes(value),))
        elif hasattr(value, "read"):
            self._write(name, _read_chunks(value))
        else:
            raise TypeError("official ParseResult.save supplied unsupported bytes")

    def write_string(self, first: object, second: str) -> None:
        name, value = self._arguments(first, second)
        if not isinstance(value, str):
            raise TypeError("official ParseResult.save supplied non-text")
        self._write(
            name,
            (value[index : index + 64 * 1024].encode("utf-8") for index in range(0, len(value), 64 * 1024)),
        )


def _rewrite_json_references(
    value: str, aliases: dict[str, str], limit: int = MAX_TEXT_JSON_BYTES
) -> str:
    if len(value.encode("utf-8")) > limit:
        raise LimitError("official text or JSON file exceeds its limit")
    try:
        parsed = json.loads(value)
    except (UnicodeDecodeError, json.JSONDecodeError):
        return value

    def rewrite(item: object) -> tuple[object, bool]:
        if isinstance(item, dict):
            changed = False
            rewritten: dict[object, object] = {}
            for key, child in item.items():
                new_child, child_changed = rewrite(child)
                rewritten[key] = new_child
                changed = changed or child_changed
            return rewritten, changed
        if isinstance(item, list):
            changed = False
            rewritten = []
            for child in item:
                new_child, child_changed = rewrite(child)
                rewritten.append(new_child)
                changed = changed or child_changed
            return rewritten, changed
        if isinstance(item, str):
            replacement = aliases.get(item)
            if replacement is not None and replacement != item:
                return replacement, True
        return item, False

    rewritten, changed = rewrite(parsed)
    if not changed:
        return value
    return json.dumps(rewritten, ensure_ascii=False, separators=(",", ":"))


def _windows_device_name(name: str) -> bool:
    base = name.split(".", 1)[0]
    try:
        encoded = base.encode("utf-8")
    except UnicodeEncodeError:
        return False
    return (
        base.isascii() and base.lower() in {"con", "prn", "aux", "nul"}
    ) or (
        len(encoded) == 4
        and encoded[:3].lower() in {b"com", b"lpt"}
        and encoded[3] in b"123456789"
    )


def _lowercase_key(value: str) -> str:
    return value.lower()


def _portable_name(name: str) -> bool:
    return (
        bool(name)
        and name not in {".", ".."}
        and not name.endswith((".", " "))
        and all(
            not (ord(character) < 32 or 127 <= ord(character) <= 159)
            and character not in "/\\<>:\"|?*"
            for character in name
        )
        and not _windows_device_name(name)
    )


def _read_chunks(stream: object) -> Iterable[Union[bytes, str]]:
    read = getattr(stream, "read")
    while True:
        chunk = read(64 * 1024)
        if chunk == b"" or chunk == "":
            return
        yield chunk


def main() -> None:
    raw = sys.stdin.buffer.read(PROTOCOL_CAP + 1)
    if len(raw) > PROTOCOL_CAP:
        _emit(_response({}, "error", "", "request exceeds protocol limit"))
        return
    capture = BoundedCapture(DIAGNOSTIC_CAP)
    try:
        request = json.loads(raw.decode("utf-8"))
        if not isinstance(request, dict):
            raise ValueError("request must be a JSON object")
        _validate_document_request(request)
        package = importlib.metadata.version("mineru")
        if package != PACKAGE_VERSION:
            _emit(_response(request, "error", package, f"MinerU package version is not {PACKAGE_VERSION}"))
            return
        with contextlib.redirect_stdout(capture), contextlib.redirect_stderr(capture):
            _document_env(request)
            importlib.import_module("mineru")
            if request.get("operation") is not None:
                from mineru_official_worker_operations import dispatch

                importlib.import_module("mineru.parser")
                dispatch(request, BundleWriter)
            else:
                parser = importlib.import_module("mineru.parser")
                kwargs = _document_parse_kwargs(request)
                result = asyncio.run(parser.parse_async(request["input_path"], **kwargs))
                result.save(BundleWriter(
                    Path(request["bundle_path"]), int(request["max_bundle_bytes"]),
                    typed_references=request.get("source_context") is not None,
                ))
        _emit(_response(request, "ok", package), capture.getvalue())
    except Exception as error:  # The parent owns the bounded failure surface.
        request = request if "request" in locals() and isinstance(request, dict) else {}
        _emit(
            _response(request, "error", locals().get("package", ""), str(error)),
            capture.getvalue(),
        )


if __name__ == "__main__":
    if "--persistent" in sys.argv[1:]:
        raise SystemExit(_persistent_main(BundleWriter))
    main()