Python2/PyMuPDF: mupdf-source/scripts/jlib.py annotate

annotate mupdf-source/scripts/jlib.py @ 38:8934ac156ef5

Allow to build with the PyPI package "clang" instead of "libclang". 1. It seems to be maintained. 2. In the FreeBSD base system there is no pre-built libclang.so. If you need this library you have to install llvm from ports additionally. 2. On FreeBSD there is no pre-built wheel "libclang" with a packaged libclang.so.

author	Franz Glasner <fzglas.hg@dom66.de>
date	Tue, 23 Sep 2025 10:27:15 +0200
parents	fdb709369d57
children	71bcc18e306f

rev	line source
2 b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1 import calendar
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2 import codecs
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	3 import inspect
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	4 import io
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	5 import os
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	6 import platform
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	7 import re
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	8 import shlex
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	9 import shutil
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	10 import subprocess
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	11 import sys
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	12 import tarfile
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	13 import textwrap
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	14 import time
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	15 import traceback
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	16 import types
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	17 import typing
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	18
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	19
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	20 def place( frame_record=1):
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	21 '''
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	22 Useful debugging function - returns representation of source position of
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	23 caller.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	24
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	25 frame_record:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	26 Integer number of frames up stack, or a `FrameInfo` (for example from
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	27 `inspect.stack()`).
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	28 '''
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	29 if isinstance( frame_record, int):
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	30 frame_record = inspect.stack( context=0)[ frame_record+1]
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	31 filename = frame_record.filename
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	32 line = frame_record.lineno
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	33 function = frame_record.function
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	34 ret = os.path.split( filename)[1] + ':' + str( line) + ':' + function + ':'
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	35 if 0: # lgtm [py/unreachable-statement]
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	36 tid = str( threading.currentThread())
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	37 ret = '[' + tid + '] ' + ret
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	38 return ret
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	39
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	40
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	41 def text_nv( text, caller=1):
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	42 '''
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	43 Returns `text` with special handling of `{<expression>}` items
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	44 constituting an enhanced and deferred form of Python f-strings
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	45 (https://docs.python.org/3/reference/lexical_analysis.html#f-strings).
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	46
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	47 text:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	48 String containing `{<expression>}` items.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	49 caller:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	50 If an `int`, the number of frames to step up when looking for file:line
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	51 information or evaluating expressions.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	52
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	53 Otherwise should be a frame record as returned by `inspect.stack()[]`.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	54
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	55 `<expression>` items are evaluated in `caller`'s context using `eval()`.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	56
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	57 If `expression` ends with `=` or has a `=` before `!` or `:`, this
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	58 character is removed and we prefix the result with `<expression>`=.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	59
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	60 >>> x = 45
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	61 >>> y = 'hello'
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	62 >>> text_nv( 'foo {x} {y=}')
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	63 "foo 45 y='hello'"
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	64
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	65 `<expression>` can also use ':' and '!' to control formatting, like
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	66 `str.format()`. We support '=' being before (PEP 501) or after the ':' or
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	67 `'!'.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	68
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	69 >>> x = 45
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	70 >>> y = 'hello'
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	71 >>> text_nv( 'foo {x} {y} {y!r=}')
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	72 "foo 45 hello y='hello'"
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	73 >>> text_nv( 'foo {x} {y=!r}')
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	74 "foo 45 y='hello'"
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	75
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	76 If `<expression>` starts with '=', this character is removed and we show
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	77 each space-separated item in the remaining text as though it was appended
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	78 with '='.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	79
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	80 >>> foo = 45
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	81 >>> y = 'hello'
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	82 >>> text_nv('{=foo y}')
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	83 "foo=45 y='hello'"
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	84
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	85 Also see https://peps.python.org/pep-0501/.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	86
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	87 Check handling of ':' within brackets:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	88
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	89 >>> text_nv('{time.strftime("%Y-%m-%d %H:%M:%S", time.gmtime(1670059297))=}')
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	90 'time.strftime("%Y-%m-%d %H:%M:%S", time.gmtime(1670059297))=\\'2022-12-03 09:21:37\\''
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	91 '''
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	92 if isinstance( caller, int):
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	93 frame_record = inspect.stack()[ caller]
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	94 else:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	95 frame_record = caller
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	96 frame = frame_record.frame
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	97 try:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	98 def get_items():
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	99 '''
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	100 Yields `(pre, item)`, where `item` is contents of next `{...}` or
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	101 `None`, and `pre` is preceding text.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	102 '''
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	103 pos = 0
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	104 pre = ''
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	105 while 1:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	106 if pos == len( text):
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	107 yield pre, None
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	108 break
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	109 rest = text[ pos:]
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	110 if rest.startswith( '{{') or rest.startswith( '}}'):
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	111 pre += rest[0]
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	112 pos += 2
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	113 elif text[ pos] == '{':
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	114 close = text.find( '}', pos)
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	115 if close < 0:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	116 raise Exception( 'After "{" at offset %s, cannot find closing "}". text is: %r' % (
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	117 pos, text))
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	118 text2 = text[ pos+1 : close]
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	119 if text2.startswith('='):
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	120 text2 = text2[1:]
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	121 for i, text3 in enumerate(text2.split()):
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	122 pre2 = ' ' if i else pre
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	123 yield pre2, text3 + '='
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	124 else:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	125 yield pre, text[ pos+1 : close]
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	126 pre = ''
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	127 pos = close + 1
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	128 else:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	129 pre += text[ pos]
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	130 pos += 1
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	131
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	132 ret = ''
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	133 for pre, item in get_items():
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	134 ret += pre
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	135 nv = False
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	136 if item:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	137 if item.endswith( '='):
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	138 nv = True
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	139 item = item[:-1]
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	140 expression, tail = text_split_last_of( item, ')]!:')
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	141 if tail.startswith( (')', ']')):
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	142 expression, tail = item, ''
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	143 if expression.endswith('='):
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	144 # Basic PEP 501 support.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	145 nv = True
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	146 expression = expression[:-1]
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	147 if nv and not tail:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	148 # Default to !r as in PEP 501.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	149 tail = '!r'
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	150 try:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	151 value = eval( expression, frame.f_globals, frame.f_locals)
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	152 value_text = ('{0%s}' % tail).format( value)
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	153 except Exception as e:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	154 value_text = '{??Failed to evaluate %r in context %s:%s; expression=%r tail=%r: %s}' % (
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	155 expression,
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	156 frame_record.filename,
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	157 frame_record.lineno,
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	158 expression,
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	159 tail,
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	160 e,
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	161 )
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	162 if nv:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	163 ret += '%s=' % expression
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	164 ret += value_text
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	165
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	166 return ret
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	167
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	168 finally:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	169 del frame # lgtm [py/unnecessary-delete]
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	170
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	171
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	172 class LogPrefixTime:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	173 def __init__( self, date=False, time_=True, elapsed=False):
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	174 self.date = date
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	175 self.time = time_
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	176 self.elapsed = elapsed
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	177 self.t0 = time.time()
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	178 def __call__( self):
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	179 ret = ''
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	180 if self.date:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	181 ret += time.strftime( ' %F')
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	182 if self.time:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	183 ret += time.strftime( ' %T')
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	184 if self.elapsed:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	185 ret += ' (+%s)' % time_duration( time.time() - self.t0, s_format='%.1f')
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	186 if ret:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	187 ret = ret.strip() + ': '
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	188 return ret
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	189
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	190 class LogPrefixFileLine:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	191 def __call__( self, caller):
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	192 if isinstance( caller, int):
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	193 caller = inspect.stack()[ caller]
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	194 return place( caller) + ' '
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	195
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	196 class LogPrefixScopes:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	197 '''
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	198 Internal use only.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	199 '''
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	200 def __init__( self):
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	201 self.items = []
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	202 def __call__( self):
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	203 ret = ''
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	204 for item in self.items:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	205 if callable( item):
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	206 item = item()
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	207 ret += item
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	208 return ret
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	209
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	210
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	211 class LogPrefixScope:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	212 '''
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	213 Can be used to insert scoped prefix to log output.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	214 '''
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	215 def __init__( self, prefix):
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	216 self.prefix = prefix
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	217 def __enter__( self):
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	218 g_log_prefix_scopes.items.append( self.prefix)
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	219 def __exit__( self, exc_type, exc_value, traceback):
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	220 global g_log_prefix
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	221 g_log_prefix_scopes.items.pop()
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	222
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	223
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	224 g_log_delta = 0
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	225
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	226 class LogDeltaScope:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	227 '''
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	228 Can be used to temporarily change verbose level of logging.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	229
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	230 E.g to temporarily increase logging::
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	231
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	232 with jlib.LogDeltaScope(-1):
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	233 ...
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	234 '''
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	235 def __init__( self, delta):
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	236 self.delta = delta
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	237 global g_log_delta
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	238 g_log_delta += self.delta
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	239 def __enter__( self):
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	240 pass
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	241 def __exit__( self, exc_type, exc_value, traceback):
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	242 global g_log_delta
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	243 g_log_delta -= self.delta
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	244
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	245 # Special item that can be inserted into <g_log_prefixes> to enable
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	246 # temporary addition of text into log prefixes.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	247 #
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	248 g_log_prefix_scopes = LogPrefixScopes()
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	249
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	250 # List of items that form prefix for all output from log().
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	251 #
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	252 g_log_prefixes = [
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	253 LogPrefixTime( time_=False, elapsed=True),
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	254 g_log_prefix_scopes,
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	255 LogPrefixFileLine(),
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	256 ]
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	257
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	258
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	259 _log_text_line_start = True
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	260
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	261 def log_text( text=None, caller=1, nv=True, raw=False, nl=True):
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	262 '''
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	263 Returns log text, prepending all lines with text from `g_log_prefixes`.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	264
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	265 text:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	266 The text to output.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	267 caller:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	268 If an int, the number of frames to step up when looking for file:line
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	269 information or evaluating expressions.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	270
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	271 Otherwise should be a frame record as returned by `inspect.stack()[]`.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	272 nv:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	273 If true, we expand `{...}` in `text` using `jlib.text_nv()`.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	274 raw:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	275 If true we don't terminate with newlines and store state in
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	276 `_log_text_line_start` so that we generate correct content if sent sent
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	277 partial lines.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	278 nl:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	279 If true (the default) we terminate text with a newline if not already
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	280 present. Ignored if `raw` is true.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	281 '''
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	282 if isinstance( caller, int):
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	283 caller += 1
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	284 # Construct line prefix.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	285 prefix = ''
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	286 for p in g_log_prefixes:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	287 if callable( p):
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	288 if isinstance( p, LogPrefixFileLine):
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	289 p = p(caller)
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	290 else:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	291 p = p()
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	292 prefix += p
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	293
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	294 if text is None:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	295 return prefix
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	296
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	297 # Expand {...} using our enhanced f-string support.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	298 if nv:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	299 text = text_nv( text, caller)
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	300
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	301 # Prefix each line. If <raw> is false, we terminate the last line with a
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	302 # newline. Otherwise we use _log_text_line_start to remember whether we are
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	303 # at the beginning of a line.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	304 #
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	305 global _log_text_line_start
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	306 text2 = ''
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	307 pos = 0
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	308 while 1:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	309 if pos == len(text):
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	310 break
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	311 if not raw or _log_text_line_start:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	312 text2 += prefix
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	313 nlp = text.find('\n', pos)
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	314 if nlp == -1:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	315 text2 += text[pos:]
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	316 if not raw and nl:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	317 text2 += '\n'
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	318 pos = len(text)
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	319 else:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	320 text2 += text[pos:nlp+1]
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	321 pos = nlp+1
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	322 if raw:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	323 _log_text_line_start = (nlp >= 0)
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	324 return text2
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	325
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	326
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	327 s_log_levels_cache = dict()
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	328 s_log_levels_items = []
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	329
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	330 def log_levels_find( caller):
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	331 if not s_log_levels_items:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	332 return 0
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	333
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	334 tb = traceback.extract_stack( None, 1+caller)
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	335 if len(tb) == 0:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	336 return 0
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	337 filename, line, function, text = tb[0]
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	338
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	339 key = function, filename, line,
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	340 delta = s_log_levels_cache.get( key)
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	341
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	342 if delta is None:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	343 # Calculate and populate cache.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	344 delta = 0
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	345 for item_function, item_filename, item_delta in s_log_levels_items:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	346 if item_function and not function.startswith( item_function):
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	347 continue
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	348 if item_filename and not filename.startswith( item_filename):
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	349 continue
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	350 delta = item_delta
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	351 break
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	352
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	353 s_log_levels_cache[ key] = delta
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	354
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	355 return delta
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	356
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	357
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	358 def log_levels_add( delta, filename_prefix, function_prefix):
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	359 '''
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	360 `jlib.log()` calls from locations with filenames starting with
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	361 `filename_prefix` and/or function names starting with `function_prefix`
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	362 will have `delta` added to their level.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	363
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	364 Use -ve `delta` to increase verbosity from particular filename or function
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	365 prefixes.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	366 '''
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	367 log( 'adding level: {filename_prefix=!r} {function_prefix=!r}')
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	368
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	369 # Sort in reverse order so that long functions and filename specs come
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	370 # first.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	371 #
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	372 s_log_levels_items.append( (function_prefix, filename_prefix, delta))
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	373 s_log_levels_items.sort( reverse=True)
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	374
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	375
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	376 s_log_out = sys.stdout
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	377
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	378 def log( text, level=0, caller=1, nv=True, out=None, raw=False):
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	379 '''
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	380 Writes log text, with special handling of `{<expression>}` items in `text`
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	381 similar to python3's f-strings.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	382
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	383 text:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	384 The text to output.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	385 level:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	386 Lower values are more verbose.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	387 caller:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	388 How many frames to step up to get caller's context when evaluating
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	389 file:line information and/or expressions. Or frame record as returned
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	390 by `inspect.stack()[]`.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	391 nv:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	392 If true, we expand `{...}` in `text` using `jlib.text_nv()`.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	393 out:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	394 Where to send output. If None we use sys.stdout.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	395 raw:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	396 If true we don't ensure output text is terminated with a newline. E.g.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	397 use by `jlib.system()` when sending us raw output which is not
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	398 line-based.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	399
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	400 `<expression>` is evaluated in our caller's context (`n` stack frames up)
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	401 using `eval()`, and expanded to `<expression>` or `<expression>=<value>`.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	402
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	403 If `<expression>` ends with '=', this character is removed and we prefix
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	404 the result with <expression>=.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	405
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	406 E.g.::
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	407
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	408 x = 45
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	409 y = 'hello'
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	410 text_nv( 'foo {x} {y=}')
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	411
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	412 returns::
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	413
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	414 foo 45 y=hello
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	415
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	416 `<expression>` can also use ':' and '!' to control formatting, like
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	417 `str.format()`.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	418 '''
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	419 if out is None:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	420 out = s_log_out
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	421 level += g_log_delta
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	422 if isinstance( caller, int):
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	423 caller += 1
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	424 level += log_levels_find( caller)
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	425 if level <= 0:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	426 text = log_text( text, caller, nv=nv, raw=raw)
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	427 try:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	428 out.write( text)
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	429 except UnicodeEncodeError:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	430 # Retry, ignoring errors by encoding then decoding with
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	431 # errors='replace'.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	432 #
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	433 out.write('[*write encoding error*]')
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	434 text_encoded = codecs.encode(text, out.encoding, errors='replace')
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	435 text_encoded_decoded = codecs.decode(text_encoded, out.encoding, errors='replace')
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	436 out.write(text_encoded_decoded)
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	437 out.write('[/*write encoding error*]')
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	438 out.flush()
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	439
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	440 def log_raw( text, level=0, caller=1, nv=False, out=None):
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	441 '''
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	442 Like `jlib.log()` but defaults to `nv=False` so any `{...}` are not
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	443 evaluated as expressions.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	444
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	445 Useful for things like::
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	446
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	447 jlib.system(..., out=jlib.log_raw)
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	448 '''
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	449 log( text, level=0, caller=caller+1, nv=nv, out=out)
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	450
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	451 def log0( text, caller=1, nv=True, out=None):
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	452 '''
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	453 Most verbose log. Same as log().
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	454 '''
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	455 log( text, level=0, caller=caller+1, nv=nv, out=out)
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	456
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	457 def log1( text, caller=1, nv=True, out=None):
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	458 log( text, level=1, caller=caller+1, nv=nv, out=out)
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	459
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	460 def log2( text, caller=1, nv=True, out=None):
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	461 log( text, level=2, caller=caller+1, nv=nv, out=out)
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	462
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	463 def log3( text, caller=1, nv=True, out=None):
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	464 log( text, level=3, caller=caller+1, nv=nv, out=out)
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	465
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	466 def log4( text, caller=1, nv=True, out=None):
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	467 log( text, level=4, caller=caller+1, nv=nv, out=out)
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	468
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	469 def log5( text, caller=1, nv=True, out=None):
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	470 '''
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	471 Least verbose log.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	472 '''
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	473 log( text, level=5, caller=caller+1, nv=nv, out=out)
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	474
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	475 def logx( text, caller=1, nv=True, out=None):
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	476 '''
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	477 Does nothing, useful when commenting out a log().
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	478 '''
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	479 pass
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	480
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	481
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	482 _log_interval_t0 = 0
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	483
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	484 def log_interval( text, level=0, caller=1, nv=True, out=None, raw=False, interval=10):
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	485 '''
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	486 Like `jlib.log()` but outputs no more than one diagnostic every `interval`
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	487 seconds, and `text` can be a callable taking no args and returning a
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	488 string.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	489 '''
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	490 global _log_interval_t0
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	491 t = time.time()
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	492 if t - _log_interval_t0 > interval:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	493 _log_interval_t0 = t
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	494 if callable( text):
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	495 text = text()
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	496 log( text, level=level, caller=caller+1, nv=nv, out=out, raw=raw)
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	497
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	498
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	499 def log_levels_add_env( name='JLIB_log_levels'):
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	500 '''
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	501 Added log levels encoded in an environmental variable.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	502 '''
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	503 t = os.environ.get( name)
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	504 if t:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	505 for ffll in t.split( ','):
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	506 ffl, delta = ffll.split( '=', 1)
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	507 delta = int( delta)
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	508 ffl = ffl.split( ':')
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	509 if 0: # lgtm [py/unreachable-statement]
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	510 pass
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	511 elif len( ffl) == 1:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	512 filename = ffl
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	513 function = None
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	514 elif len( ffl) == 2:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	515 filename, function = ffl
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	516 else:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	517 assert 0
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	518 log_levels_add( delta, filename, function)
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	519
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	520
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	521 class TimingsItem:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	522 '''
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	523 Helper for `Timings` class.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	524 '''
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	525 def __init__( self, name):
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	526 self.name = name
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	527 self.children = dict()
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	528 self.t_begin = None
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	529 self.t = 0
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	530 self.n = 0
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	531 def begin( self, t):
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	532 assert self.t_begin is None
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	533 self.t_begin = t
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	534 def end( self, t):
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	535 assert self.t_begin is not None, f't_begin is None, .name={self.name}'
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	536 self.t += t - self.t_begin
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	537 self.n += 1
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	538 self.t_begin = None
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	539 def __str__( self):
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	540 return f'[name={self.name} t={self.t} n={self.n} t_begin={self.t_begin}]'
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	541 def __repr__( self):
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	542 return self.__str__()
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	543
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	544 class Timings:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	545 '''
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	546 Allows gathering of hierarchical timing information. Can also generate
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	547 useful diagnostics.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	548
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	549 Caller can generate a tree of `TimingsItem` items via our `begin()` and
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	550 `end()` methods.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	551
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	552 >>> ts = Timings()
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	553 >>> ts.begin('a')
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	554 >>> time.sleep(0.1)
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	555 >>> ts.begin('b')
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	556 >>> time.sleep(0.2)
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	557 >>> ts.begin('c')
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	558 >>> time.sleep(0.3)
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	559 >>> ts.end('c')
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	560 >>> ts.begin('c')
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	561 >>> time.sleep(0.3)
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	562 >>> ts.end('b') # will also end 'c'.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	563 >>> ts.begin('d')
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	564 >>> ts.begin('e')
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	565 >>> time.sleep(0.1)
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	566 >>> ts.end_all() # will end everything.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	567 >>> print(ts)
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	568 Timings (in seconds):
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	569 1.0 a
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	570 0.8 b
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	571 0.6/2 c
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	572 0.1 d
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	573 0.1 e
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	574 <BLANKLINE>
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	575
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	576 One can also use as a context manager:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	577
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	578 >>> ts = Timings()
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	579 >>> with ts( 'foo'):
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	580 ... time.sleep(1)
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	581 ... with ts( 'bar'):
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	582 ... time.sleep(1)
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	583 >>> print( ts)
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	584 Timings (in seconds):
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	585 2.0 foo
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	586 1.0 bar
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	587 <BLANKLINE>
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	588
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	589 Must specify name, otherwise we assert-fail.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	590
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	591 >>> with ts:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	592 ... pass
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	593 Traceback (most recent call last):
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	594 AssertionError: Must specify <name> etc when using "with ...".
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	595 '''
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	596 def __init__( self, name='', active=True):
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	597 '''
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	598 If `active` is False, returned instance does nothing.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	599 '''
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	600 self.active = active
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	601 self.root_item = TimingsItem( name)
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	602 self.nest = [ self.root_item]
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	603 self.nest[0].begin( time.time())
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	604 self.name_max_len = 0
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	605 self.call_enter_state = None
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	606 self.call_enter_stack = []
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	607
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	608 def begin( self, name=None, text=None, level=0, t=None):
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	609 '''
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	610 Starts a new timing item as child of most recent in-progress timing
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	611 item.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	612
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	613 name:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	614 Used in final statistics. If `None`, we use `jlib.place()`.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	615 text:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	616 If not `None`, this is output here with `jlib.log()`.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	617 level:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	618 Verbosity. Added to `g_verbose`.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	619 '''
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	620 if not self.active:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	621 return
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	622 if t is None:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	623 t = time.time()
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	624 if name is None:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	625 name = place(2)
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	626 self.name_max_len = max( self.name_max_len, len(name))
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	627 leaf = self.nest[-1].children.setdefault( name, TimingsItem( name))
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	628 self.nest.append( leaf)
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	629 leaf.begin( t)
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	630 if text:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	631 log( text, nv=0)
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	632
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	633 def end( self, name=None, t=None):
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	634 '''
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	635 Repeatedly ends the most recent item until we have ended item called
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	636 `name`. Ends just the most recent item if name is `None`.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	637 '''
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	638 if not self.active:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	639 return
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	640 if t is None:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	641 t = time.time()
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	642 if name is None:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	643 name = self.nest[-1].name
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	644 while self.nest:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	645 leaf = self.nest.pop()
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	646 leaf.end( t)
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	647 if leaf.name == name:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	648 break
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	649 else:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	650 if name is not None:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	651 log( f'*** Warning: cannot end timing item called {name} because not found.')
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	652
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	653 def end_all( self):
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	654 self.end( self.nest[0].name)
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	655
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	656 def mid( self, name=None):
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	657 '''
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	658 Ends current leaf item and starts a new item called `name`. Useful to
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	659 define multiple timing blocks at same level.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	660 '''
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	661 if not self.active:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	662 return
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	663 t = time.time()
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	664 if len( self.nest) > 1:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	665 self.end( self.nest[-1].name, t)
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	666 self.begin( name, t=t)
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	667
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	668 def __enter__( self):
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	669 if not self.active:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	670 return
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	671 assert self.call_enter_state, 'Must specify <name> etc when using "with ...".'
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	672 name, text, level = self.call_enter_state
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	673 self.begin( name, text, level)
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	674 self.call_enter_state = None
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	675 self.call_enter_stack.append( name)
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	676
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	677 def __exit__( self, type, value, traceback):
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	678 if not self.active:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	679 return
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	680 assert not self.call_enter_state, f'self.call_enter_state is not false: {self.call_enter_state}'
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	681 name = self.call_enter_stack.pop()
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	682 self.end( name)
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	683
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	684 def __call__( self, name=None, text=None, level=0):
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	685 '''
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	686 Allow scoped timing.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	687 '''
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	688 if not self.active:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	689 return self
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	690 assert not self.call_enter_state, f'self.call_enter_state is not false: {self.call_enter_state}'
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	691 self.call_enter_state = ( name, text, level)
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	692 return self
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	693
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	694 def text( self, item, depth=0, precision=1):
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	695 '''
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	696 Returns text showing hierarchical timing information.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	697 '''
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	698 if not self.active:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	699 return ''
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	700 if item is self.root_item and not item.name:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	701 # Don't show top-level.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	702 ret = ''
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	703 else:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	704 tt = ' None' if item.t is None else f'{item.t:6.{precision}f}'
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	705 n = f'/{item.n}' if item.n >= 2 else ''
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	706 ret = f'{" " * 4 * depth} {tt}{n} {item.name}\n'
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	707 depth += 1
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	708 for _, timing2 in item.children.items():
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	709 ret += self.text( timing2, depth, precision)
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	710 return ret
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	711
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	712 def __str__( self):
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	713 ret = 'Timings (in seconds):\n'
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	714 ret += self.text( self.root_item, 0)
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	715 return ret
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	716
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	717
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	718 def text_strpbrk_reverse( text, substrings):
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	719 '''
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	720 Finds last occurrence of any item in `substrings` in `text`.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	721
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	722 Returns `(pos, substring)` or `(len(text), None)` if not found.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	723 '''
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	724 ret_pos = -1
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	725 ret_substring = None
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	726 for substring in substrings:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	727 pos = text.rfind( substring)
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	728 if pos >= 0 and pos > ret_pos:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	729 ret_pos = pos
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	730 ret_substring = substring
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	731 if ret_pos == -1:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	732 ret_pos = len( text)
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	733 return ret_pos, ret_substring
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	734
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	735
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	736 def text_split_last_of( text, substrings):
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	737 '''
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	738 Returns `(pre, post)`, where `pre` doesn't contain any item in `substrings`
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	739 and `post` is empty or starts with an item in `substrings`.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	740 '''
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	741 pos, _ = text_strpbrk_reverse( text, substrings)
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	742
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	743 return text[ :pos], text[ pos:]
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	744
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	745
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	746
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	747 log_levels_add_env()
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	748
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	749
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	750 def force_line_buffering():
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	751 '''
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	752 Ensure `sys.stdout` and `sys.stderr` are line-buffered. E.g. makes things
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	753 work better if output is piped to a file via 'tee'.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	754
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	755 Returns original out,err streams.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	756 '''
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	757 stdout0 = sys.stdout
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	758 stderr0 = sys.stderr
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	759 sys.stdout = os.fdopen( sys.stdout.fileno(), 'w', 1)
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	760 sys.stderr = os.fdopen( sys.stderr.fileno(), 'w', 1)
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	761 return stdout0, stderr0
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	762
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	763
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	764 def exception_info(
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	765 exception_or_traceback=None,
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	766 limit=None,
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	767 file=None,
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	768 chain=True,
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	769 outer=True,
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	770 show_exception_type=True,
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	771 _filelinefn=True,
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	772 ):
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	773 '''
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	774 Shows an exception and/or backtrace.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	775
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	776 Alternative to `traceback.*` functions that print/return information about
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	777 exceptions and backtraces, such as:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	778
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	779 * `traceback.format_exc()`
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	780 * `traceback.format_exception()`
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	781 * `traceback.print_exc()`
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	782 * `traceback.print_exception()`
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	783
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	784 Install as system default with:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	785
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	786 `sys.excepthook = lambda type_, exception, traceback: jlib.exception_info( exception)`
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	787
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	788 Returns `None`, or the generated text if `file` is 'return'.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	789
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	790 Args:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	791 exception_or_traceback:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	792 `None`, a `BaseException`, a `types.TracebackType` (typically from
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	793 an exception's `.__traceback__` member) or an `inspect.FrameInfo`.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	794
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	795 If `None` we use current exception from `sys.exc_info()` if set,
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	796 otherwise the current backtrace from `inspect.stack()`.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	797 limit:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	798 As in `traceback.*` functions: `None` to show all frames, positive
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	799 to show last `limit` frames, negative to exclude outermost `-limit`
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	800 frames. Zero to not show any backtraces.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	801 file:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	802 As in `traceback.*` functions: file-like object to which we write
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	803 output, or `sys.stderr` if `None`. Special value 'return' makes us
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	804 return our output as a string.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	805 chain:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	806 As in `traceback.*` functions: if true (the default) we show
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	807 chained exceptions as described in PEP-3134. Special value
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	808 'because' reverses the usual ordering, showing higher-level
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	809 exceptions first and joining with 'Because:' text.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	810 outer:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	811 If true (the default) we also show an exception's outer frames
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	812 above the `catch` block (see next section for details). We
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	813 use `outer=false` internally for chained exceptions to avoid
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	814 duplication.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	815 show_exception_type:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	816 Controls whether exception text is prefixed by
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	817 `f'{type(exception)}: '`. If callable we only include this prefix
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	818 if `show_exception_type(exception)` is true. Otherwise if true (the
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	819 default) we include the prefix for all exceptions (this mimcs the
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	820 behaviour of `traceback.*` functions). Otherwise we exclude the
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	821 prefix for all exceptions.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	822 _filelinefn:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	823 Internal only; makes us omit file:line: information to allow simple
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	824 doctest comparison with expected output.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	825
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	826 Differences from `traceback.*` functions:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	827
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	828 Frames are displayed as one line in the form::
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	829
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	830 <file>:<line>:<function>: <text>
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	831
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	832 Filenames are displayed as relative to the current directory if
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	833 applicable.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	834
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	835 Inclusion of outer frames:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	836 Unlike `traceback.*` functions, stack traces for exceptions include
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	837 outer stack frames above the point at which an exception was caught
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	838 - i.e. frames from the top-level <module> or thread creation to the
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	839 catch block. [Search for 'sys.exc_info backtrace incomplete' for
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	840 more details.]
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	841
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	842 We separate the two parts of the backtrace using a marker line
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	843 '^except raise:' where '^except' points upwards to the frame that
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	844 caught the exception and 'raise:' refers downwards to the frame
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	845 that raised the exception.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	846
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	847 So the backtrace for an exception looks like this::
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	848
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	849 <file>:<line>:<fn>: <text> [in root module.]
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	850 ... [... other frames]
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	851 <file>:<line>:<fn>: <text> [in except: block where exception was caught.]
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	852 ^except raise: [marker line]
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	853 <file>:<line>:<fn>: <text> [in try: block.]
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	854 ... [... other frames]
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	855 <file>:<line>:<fn>: <text> [where the exception was raised.]
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	856
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	857 Examples:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	858
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	859 In these examples we use `file=sys.stdout` so we can check the output
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	860 with `doctest`, and set `_filelinefn=0` so that the output can be
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	861 matched easily. We also use `+ELLIPSIS` and `...` to match arbitrary
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	862 outer frames from the doctest code itself.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	863
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	864 Basic handling of an exception:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	865
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	866 >>> def c():
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	867 ... raise Exception( 'c() failed')
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	868 >>> def b():
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	869 ... try:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	870 ... c()
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	871 ... except Exception as e:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	872 ... exception_info( e, file=sys.stdout, _filelinefn=0)
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	873 >>> def a():
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	874 ... b()
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	875
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	876 >>> a() # doctest: +REPORT_UDIFF +ELLIPSIS
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	877 Traceback (most recent call last):
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	878 ...
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	879 a(): b()
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	880 b(): exception_info( e, file=sys.stdout, _filelinefn=0)
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	881 ^except raise:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	882 b(): c()
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	883 c(): raise Exception( 'c() failed')
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	884 Exception: c() failed
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	885
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	886 Handling of chained exceptions:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	887
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	888 >>> def e():
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	889 ... raise Exception( 'e(): deliberate error')
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	890 >>> def d():
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	891 ... e()
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	892 >>> def c():
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	893 ... try:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	894 ... d()
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	895 ... except Exception as e:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	896 ... raise Exception( 'c: d() failed') from e
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	897 >>> def b():
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	898 ... try:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	899 ... c()
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	900 ... except Exception as e:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	901 ... exception_info( file=sys.stdout, chain=g_chain, _filelinefn=0)
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	902 >>> def a():
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	903 ... b()
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	904
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	905 With `chain=True` (the default), we output low-level exceptions
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	906 first, matching the behaviour of `traceback.*` functions:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	907
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	908 >>> g_chain = True
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	909 >>> a() # doctest: +REPORT_UDIFF +ELLIPSIS
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	910 Traceback (most recent call last):
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	911 c(): d()
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	912 d(): e()
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	913 e(): raise Exception( 'e(): deliberate error')
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	914 Exception: e(): deliberate error
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	915 <BLANKLINE>
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	916 The above exception was the direct cause of the following exception:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	917 Traceback (most recent call last):
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	918 ...
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	919 <module>(): a() # doctest: +REPORT_UDIFF +ELLIPSIS
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	920 a(): b()
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	921 b(): exception_info( file=sys.stdout, chain=g_chain, _filelinefn=0)
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	922 ^except raise:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	923 b(): c()
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	924 c(): raise Exception( 'c: d() failed') from e
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	925 Exception: c: d() failed
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	926
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	927 With `chain='because'`, we output high-level exceptions first:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	928 >>> g_chain = 'because'
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	929 >>> a() # doctest: +REPORT_UDIFF +ELLIPSIS
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	930 Traceback (most recent call last):
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	931 ...
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	932 <module>(): a() # doctest: +REPORT_UDIFF +ELLIPSIS
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	933 a(): b()
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	934 b(): exception_info( file=sys.stdout, chain=g_chain, _filelinefn=0)
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	935 ^except raise:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	936 b(): c()
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	937 c(): raise Exception( 'c: d() failed') from e
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	938 Exception: c: d() failed
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	939 <BLANKLINE>
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	940 Because:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	941 Traceback (most recent call last):
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	942 c(): d()
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	943 d(): e()
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	944 e(): raise Exception( 'e(): deliberate error')
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	945 Exception: e(): deliberate error
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	946
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	947 Show current backtrace by passing `exception_or_traceback=None`:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	948 >>> def c():
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	949 ... exception_info( None, file=sys.stdout, _filelinefn=0)
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	950 >>> def b():
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	951 ... return c()
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	952 >>> def a():
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	953 ... return b()
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	954
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	955 >>> a() # doctest: +REPORT_UDIFF +ELLIPSIS
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	956 Traceback (most recent call last):
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	957 ...
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	958 <module>(): a() # doctest: +REPORT_UDIFF +ELLIPSIS
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	959 a(): return b()
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	960 b(): return c()
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	961 c(): exception_info( None, file=sys.stdout, _filelinefn=0)
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	962
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	963 Show an exception's `.__traceback__` backtrace:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	964 >>> def c():
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	965 ... raise Exception( 'foo') # raise
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	966 >>> def b():
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	967 ... return c() # call c
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	968 >>> def a():
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	969 ... try:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	970 ... b() # call b
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	971 ... except Exception as e:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	972 ... exception_info( e.__traceback__, file=sys.stdout, _filelinefn=0)
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	973
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	974 >>> a() # doctest: +REPORT_UDIFF +ELLIPSIS
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	975 Traceback (most recent call last):
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	976 ...
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	977 a(): b() # call b
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	978 b(): return c() # call c
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	979 c(): raise Exception( 'foo') # raise
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	980 '''
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	981 # Set exactly one of <exception> and <tb>.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	982 #
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	983 if isinstance( exception_or_traceback, (types.TracebackType, inspect.FrameInfo)):
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	984 # Simple backtrace, no Exception information.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	985 exception = None
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	986 tb = exception_or_traceback
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	987 elif isinstance( exception_or_traceback, BaseException):
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	988 exception = exception_or_traceback
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	989 tb = None
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	990 elif exception_or_traceback is None:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	991 # Show exception if available, else backtrace.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	992 _, exception, tb = sys.exc_info()
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	993 tb = None if exception else inspect.stack()[1:]
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	994 else:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	995 assert 0, f'Unrecognised exception_or_traceback type: {type(exception_or_traceback)}'
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	996
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	997 if file == 'return':
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	998 out = io.StringIO()
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	999 else:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1000 out = file if file else sys.stderr
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1001
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1002 def do_chain( exception):
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1003 exception_info(
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1004 exception,
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1005 limit,
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1006 out,
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1007 chain,
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1008 outer=False,
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1009 show_exception_type=show_exception_type,
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1010 _filelinefn=_filelinefn,
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1011 )
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1012
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1013 if exception and chain and chain != 'because' and chain != 'because-compact':
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1014 # Output current exception first.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1015 if exception.__cause__:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1016 do_chain( exception.__cause__)
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1017 out.write( '\nThe above exception was the direct cause of the following exception:\n')
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1018 elif exception.__context__:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1019 do_chain( exception.__context__)
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1020 out.write( '\nDuring handling of the above exception, another exception occurred:\n')
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1021
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1022 cwd = os.getcwd() + os.sep
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1023
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1024 def output_frames( frames, reverse, limit):
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1025 if limit == 0:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1026 return
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1027 if reverse:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1028 assert isinstance( frames, list)
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1029 frames = reversed( frames)
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1030 if limit is not None:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1031 frames = list( frames)
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1032 frames = frames[ -limit:]
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1033 for frame in frames:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1034 f, filename, line, fnname, text, index = frame
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1035 text = text[0].strip() if text else ''
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1036 if filename.startswith( cwd):
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1037 filename = filename[ len(cwd):]
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1038 if filename.startswith( f'.{os.sep}'):
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1039 filename = filename[ 2:]
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1040 if _filelinefn:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1041 out.write( f' {filename}:{line}:{fnname}(): {text}\n')
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1042 else:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1043 out.write( f' {fnname}(): {text}\n')
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1044
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1045 if limit != 0:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1046 out.write( 'Traceback (most recent call last):\n')
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1047 if exception:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1048 tb = exception.__traceback__
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1049 assert tb
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1050 if outer:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1051 output_frames( inspect.getouterframes( tb.tb_frame), reverse=True, limit=limit)
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1052 out.write( ' ^except raise:\n')
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1053 limit2 = 0 if limit == 0 else None
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1054 output_frames( inspect.getinnerframes( tb), reverse=False, limit=limit2)
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1055 else:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1056 if not isinstance( tb, list):
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1057 inner = inspect.getinnerframes(tb)
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1058 outer = inspect.getouterframes(tb.tb_frame)
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1059 tb = outer + inner
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1060 tb.reverse()
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1061 output_frames( tb, reverse=True, limit=limit)
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1062
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1063 if exception:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1064 if callable(show_exception_type):
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1065 show_exception_type2 = show_exception_type( exception)
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1066 else:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1067 show_exception_type2 = show_exception_type
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1068 if show_exception_type2:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1069 lines = traceback.format_exception_only( type(exception), exception)
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1070 for line in lines:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1071 out.write( line)
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1072 else:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1073 out.write( str( exception) + '\n')
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1074
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1075 if exception and (chain == 'because' or chain == 'because-compact'):
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1076 # Output current exception afterwards.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1077 pre, post = ('\n', '\n') if chain == 'because' else ('', ' ')
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1078 if exception.__cause__:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1079 out.write( f'{pre}Because:{post}')
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1080 do_chain( exception.__cause__)
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1081 elif exception.__context__:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1082 out.write( f'{pre}Because: error occurred handling this exception:{post}')
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1083 do_chain( exception.__context__)
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1084
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1085 if file == 'return':
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1086 return out.getvalue()
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1087
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1088
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1089 def number_sep( s):
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1090 '''
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1091 Simple number formatter, adds commas in-between thousands. `s` can be a
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1092 number or a string. Returns a string.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1093
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1094 >>> number_sep(1)
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1095 '1'
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1096 >>> number_sep(12)
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1097 '12'
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1098 >>> number_sep(123)
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1099 '123'
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1100 >>> number_sep(1234)
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1101 '1,234'
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1102 >>> number_sep(12345)
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1103 '12,345'
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1104 >>> number_sep(123456)
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1105 '123,456'
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1106 >>> number_sep(1234567)
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1107 '1,234,567'
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1108 '''
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1109 if not isinstance( s, str):
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1110 s = str( s)
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1111 c = s.find( '.')
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1112 if c==-1: c = len(s)
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1113 end = s.find('e')
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1114 if end == -1: end = s.find('E')
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1115 if end == -1: end = len(s)
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1116 ret = ''
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1117 for i in range( end):
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1118 ret += s[i]
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1119 if i<c-1 and (c-i-1)%3==0:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1120 ret += ','
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1121 elif i>c and i<end-1 and (i-c)%3==0:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1122 ret += ','
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1123 ret += s[end:]
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1124 return ret
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1125
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1126
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1127 class Stream:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1128 '''
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1129 Base layering abstraction for streams - abstraction for things like
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1130 `sys.stdout` to allow prefixing of all output, e.g. with a timestamp.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1131 '''
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1132 def __init__( self, stream):
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1133 self.stream = stream
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1134 def write( self, text):
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1135 self.stream.write( text)
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1136
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1137 class StreamPrefix:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1138 '''
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1139 Prefixes output with a prefix, which can be a string, or a callable that
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1140 takes no parameters and return a string, or an integer number of spaces.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1141 '''
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1142 def __init__( self, stream, prefix):
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1143 if callable(stream):
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1144 self.stream_write = stream
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1145 self.stream_flush = lambda: None
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1146 else:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1147 self.stream_write = stream.write
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1148 self.stream_flush = stream.flush
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1149 self.at_start = True
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1150 if callable(prefix):
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1151 self.prefix = prefix
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1152 elif isinstance( prefix, int):
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1153 self.prefix = lambda: ' ' * prefix
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1154 else:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1155 self.prefix = lambda : prefix
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1156
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1157 def write( self, text):
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1158 if self.at_start:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1159 text = self.prefix() + text
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1160 self.at_start = False
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1161 append_newline = False
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1162 if text.endswith( '\n'):
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1163 text = text[:-1]
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1164 self.at_start = True
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1165 append_newline = True
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1166 text = text.replace( '\n', '\n%s' % self.prefix())
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1167 if append_newline:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1168 text += '\n'
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1169 self.stream_write( text)
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1170
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1171 def flush( self):
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1172 self.stream_flush()
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1173
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1174
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1175 def time_duration( seconds, verbose=False, s_format='%i'):
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1176 '''
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1177 Returns string expressing an interval.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1178
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1179 seconds:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1180 The duration in seconds
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1181 verbose:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1182 If true, return like '4 days 1 hour 2 mins 23 secs', otherwise as
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1183 '4d3h2m23s'.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1184 s_format:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1185 If specified, use as printf-style format string for seconds.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1186
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1187 >>> time_duration( 303333)
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1188 '3d12h15m33s'
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1189
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1190 We pad single-digit numbers with '0' to keep things aligned:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1191 >>> time_duration( 302703.33, s_format='%.1f')
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1192 '3d12h05m03.3s'
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1193
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1194 When verbose, we pad single-digit numbers with ' ' to keep things aligned:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1195 >>> time_duration( 302703, verbose=True)
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1196 '3 days 12 hours 5 mins 3 secs'
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1197
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1198 >>> time_duration( 302703.33, verbose=True, s_format='%.1f')
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1199 '3 days 12 hours 5 mins 3.3 secs'
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1200
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1201 >>> time_duration( 0)
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1202 '0s'
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1203
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1204 >>> time_duration( 0, verbose=True)
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1205 '0 sec'
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1206 '''
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1207 x = abs(seconds)
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1208 ret = ''
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1209 i = 0
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1210 for div, text in [
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1211 ( 60, 'sec'),
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1212 ( 60, 'min'),
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1213 ( 24, 'hour'),
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1214 ( None, 'day'),
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1215 ]:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1216 force = ( x == 0 and i == 0)
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1217 if div:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1218 remainder = x % div
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1219 x = int( x/div)
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1220 else:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1221 remainder = x
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1222 x = 0
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1223 if not verbose:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1224 text = text[0]
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1225 if remainder or force:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1226 if verbose and remainder > 1:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1227 # plural.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1228 text += 's'
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1229 if verbose:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1230 text = ' %s ' % text
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1231 if i == 0:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1232 remainder_string = s_format % remainder
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1233 else:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1234 remainder_string = str( remainder)
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1235 if x and (remainder < 10):
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1236 # Pad with space or '0' to keep alignment.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1237 pad = ' ' if verbose else '0'
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1238 remainder_string = pad + str(remainder_string)
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1239 ret = '%s%s%s' % ( remainder_string, text, ret)
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1240 i += 1
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1241 ret = ret.strip()
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1242 if ret == '':
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1243 ret = '0s'
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1244 if seconds < 0:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1245 ret = '-%s' % ret
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1246 return ret
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1247
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1248
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1249 def date_time( t=None):
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1250 if t is None:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1251 t = time.time()
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1252 return time.strftime( "%F-%T", time.gmtime( t))
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1253
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1254
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1255 def time_read_date1( text):
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1256 '''
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1257 <text> is:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1258 <year>-<month>-<day>-<hour>-<min>-<sec>
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1259
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1260 Trailing values can be omitted, e.g. `2004-3' is treated as
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1261 2004-03-0-0-0-0, i.e. 1st of March 2004. I think GMT is used,
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1262 not the local time though.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1263
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1264 >>> assert time_read_date1( '2010') == calendar.timegm( ( 2010, 1, 1, 0, 0, 0, 0, 0, 0))
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1265 >>> assert time_read_date1( '2010-1') == calendar.timegm( ( 2010, 1, 1, 0, 0, 0, 0, 0, 0))
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1266 >>> assert time_read_date1( '2015-4-25-14-39-39') == calendar.timegm( time.strptime( 'Sat Apr 25 14:39:39 2015'))
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1267 '''
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1268 pieces = text.split( '-')
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1269 if len( pieces) == 1:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1270 pieces.append( '1') # mon
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1271 if len( pieces) == 2:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1272 pieces.append( '1') # mday
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1273 if len( pieces) == 3:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1274 pieces.append( '0') # hour
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1275 if len( pieces) == 4:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1276 pieces.append( '0') # minute
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1277 if len( pieces) == 5:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1278 pieces.append( '0') # second
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1279 pieces = pieces[:6] + [ 0, 0, 0]
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1280 time_tup = tuple( map( int, pieces))
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1281 t = calendar.timegm( time_tup)
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1282 return t
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1283
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1284
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1285 def time_read_date2( text):
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1286 '''
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1287 Parses strings like '2y4d8h34m5s', returning seconds.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1288
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1289 Supported time periods are:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1290 s: seconds
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1291 m: minutes
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1292 h: hours
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1293 d: days
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1294 w: weeks
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1295 y: years
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1296 '''
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1297 #print 'text=%r' % text
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1298 text0 = ''
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1299 t = 0
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1300 i0 = 0
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1301 for i in range( len( text)):
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1302 if text[i] in 'ywdhms':
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1303 dt = int( text[i0:i])
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1304 i0=i+1
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1305 if text[i]=='s': dt *= 1
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1306 elif text[i]=='m': dt *= 60
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1307 elif text[i]=='h': dt = 6060
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1308 elif text[i]=='d': dt = 6060*24
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1309 elif text[i]=='w': dt = 6060247
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1310 elif text[i]=='y': dt = 606024365
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1311 t += dt
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1312 return t
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1313
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1314 def time_read_date3( t, origin=None):
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1315 '''
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1316 Reads a date/time specification and returns absolute time in seconds.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1317
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1318 If <text> starts with '+' or '-', reads relative time with read_date2() and
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1319 adds/subtracts from <origin> (or time.time() if None).
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1320
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1321 Otherwise parses date/time with read_date1().
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1322 '''
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1323 if t[0] in '+-':
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1324 if origin is None:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1325 origin = time.time()
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1326 dt = time_read_date2( t[1:])
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1327 if t[0] == '+':
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1328 return origin + dt
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1329 else:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1330 return origin - dt
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1331 return time_read_date1( t)
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1332
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1333
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1334 def stream_prefix_time( stream):
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1335 '''
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1336 Returns `StreamPrefix` that prefixes lines with time and elapsed time.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1337 '''
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1338 t_start = time.time()
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1339 def prefix_time():
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1340 return '%s (+%s): ' % (
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1341 time.strftime( '%T'),
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1342 time_duration( time.time() - t_start, s_format='0.1f'),
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1343 )
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1344 return StreamPrefix( stream, prefix_time)
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1345
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1346 def stdout_prefix_time():
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1347 '''
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1348 Changes `sys.stdout` to prefix time and elapsed time; returns original
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1349 `sys.stdout`.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1350 '''
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1351 ret = sys.stdout
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1352 sys.stdout = stream_prefix_time( sys.stdout)
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1353 return ret
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1354
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1355
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1356 def make_out_callable( out):
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1357 '''
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1358 Returns a stream-like object with a `.write()` method that writes to `out`.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1359 out:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1360
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1361 * Where output is sent.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1362 * If `None`, output is lost.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1363 * Otherwise if an integer, we do: `os.write( out, text)`
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1364 * Otherwise if callable, we do: `out( text)`
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1365 * Otherwise we assume `out` is python stream or similar, and do: `out.write(text)`
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1366 '''
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1367 class Ret:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1368 def write( self, text):
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1369 pass
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1370 def flush( self):
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1371 pass
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1372 ret = Ret()
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1373 if out == log:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1374 # A hack to avoid expanding '{...}' in text, if caller
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1375 # does: jlib.system(..., out=jlib.log, ...).
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1376 out = lambda text: log(text, nv=False)
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1377 if out is None:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1378 ret.write = lambda text: None
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1379 elif isinstance( out, int):
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1380 ret.write = lambda text: os.write( out, text)
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1381 elif callable( out):
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1382 ret.write = out
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1383 else:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1384 ret.write = lambda text: out.write( text)
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1385 return ret
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1386
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1387 def _env_extra_text( env_extra):
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1388 ret = ''
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1389 if env_extra:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1390 for n, v in env_extra.items():
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1391 assert isinstance( n, str), f'env_extra has non-string name {n!r}: {env_extra!r}'
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1392 assert isinstance( v, str), f'env_extra name={n!r} has non-string value {v!r}: {env_extra!r}'
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1393 ret += f'{n}={shlex.quote(v)} '
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1394 return ret
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1395
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1396 def command_env_text( command, env_extra):
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1397 '''
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1398 Returns shell command that would run `command` with environmental settings
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1399 in `env_extra`.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1400
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1401 Useful for diagnostics - the returned text can be pasted into terminal to
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1402 re-run a command manually.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1403
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1404 `command` is expected to be already shell escaped, we do not escape it with
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1405 `shlex.quote()`.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1406 '''
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1407 prefix = _env_extra_text( env_extra)
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1408 return f'{prefix}{command}'
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1409
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1410 def system(
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1411 command,
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1412 verbose=True,
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1413 raise_errors=True,
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1414 out=sys.stdout,
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1415 prefix=None,
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1416 shell=True,
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1417 encoding='utf8',
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1418 errors='replace',
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1419 executable=None,
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1420 caller=1,
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1421 bufsize=-1,
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1422 env_extra=None,
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1423 multiline=True,
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1424 ):
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1425 '''
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1426 Runs a command like `os.system()` or `subprocess.*`, but with more
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1427 flexibility.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1428
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1429 We give control over where the command's output is sent, whether to return
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1430 the output and/or exit code, and whether to raise an exception if the
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1431 command fails.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1432
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1433 Args:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1434
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1435 command:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1436 The command to run.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1437 verbose:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1438 If true, we write information about the command that was run, and
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1439 its result, to `jlib.log()`.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1440 raise_errors:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1441 If true, we raise an exception if the command fails, otherwise we
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1442 return the failing error code or zero.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1443 out:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1444 Where to send output from child process.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1445
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1446 `out` is `o` or `(o, prefix)` or list of such items. Each `o` is
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1447 matched as follows:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1448
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1449 `None`: child process inherits this process's stdout and
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1450 stderr. (Must be the only item, and `prefix` is not supported.)
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1451
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1452 `subprocess.DEVNULL`: child process's output is lost. (Must be
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1453 the only item, and `prefix` is not supported.)
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1454
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1455 'return': we store the output and include it in our return
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1456 value or exception. Can only be specified once.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1457
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1458 'log': we write to `jlib.log()` using our caller's stack
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1459 frame. Can only be specified once.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1460
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1461 An integer: we do: `os.write(o, text)`
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1462
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1463 Is callable: we do: `o(text)`
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1464
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1465 Otherwise we assume `o` is python stream or similar, and do:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1466 `o.write(text)`
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1467
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1468 If `prefix` is specified, it is applied to each line in the output
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1469 before being sent to `o`.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1470 prefix:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1471 Default prefix for all items in `out`. Can be a string, a callable
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1472 taking no args that returns a string, or an integer designating the
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1473 number of spaces.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1474 shell:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1475 Passed to underlying `subprocess.Popen()` call.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1476 encoding:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1477 Specify the encoding used to translate the command's output to
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1478 characters. If `None` we send bytes to items in `out`.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1479 errors:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1480 How to handle encoding errors; see docs for `codecs` module
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1481 for details. Defaults to 'replace' so we never raise a
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1482 `UnicodeDecodeError`.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1483 executable=None:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1484 .
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1485 caller:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1486 The number of frames to look up stack when call `jlib.log()` (used
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1487 for `out='log'` and `verbose`).
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1488 bufsize:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1489 As `subprocess.Popen()`'s `bufsize` arg, sets buffer size
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1490 when creating stdout, stderr and stdin pipes. Use 0 for
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1491 unbuffered, e.g. to see login/password prompts that don't end
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1492 with a newline. Default -1 means `io.DEFAULT_BUFFER_SIZE`. +1
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1493 (line-buffered) does not work because we read raw bytes and decode
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1494 ourselves into string.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1495 env_extra:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1496 If not `None`, a `dict` with extra items that are added to the
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1497 environment passed to the child process.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1498 multiline:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1499 If true (the default) we convert a multiline command into a single
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1500 command, but preserve the multiline representation in verbose
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1501 diagnostics.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1502
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1503 Returns:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1504
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1505 * If raise_errors is true:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1506
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1507 If the command failed, we raise an exception; if `out` contains
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1508 'return' the exception text includes the output.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1509
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1510 Else if `out` contains 'return' we return the text output from the
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1511 command.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1512
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1513 Else we return `None`.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1514
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1515 * If raise_errors is false:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1516
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1517 If `out` contains 'return', we return `(e, text)` where `e` is the
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1518 command's exit code and `text` is the output from the command.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1519
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1520 Else we return `e`, the command's return code.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1521
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1522 In the above, `e` is the `subprocess`-style returncode - the exit
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1523 code, or `-N` if killed by signal `N`.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1524
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1525 >>> print(system('echo hello a', prefix='foo:', out='return'))
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1526 foo:hello a
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1527 foo:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1528
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1529 >>> system('echo hello b', prefix='foo:', out='return', raise_errors=False)
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1530 (0, 'foo:hello b\\nfoo:')
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1531
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1532 >>> system('echo hello c && false', prefix='foo:', out='return', env_extra=dict(FOO='bar qwerty'))
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1533 Traceback (most recent call last):
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1534 Exception: Command failed: FOO='bar qwerty' echo hello c && false
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1535 Output was:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1536 foo:hello c
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1537 foo:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1538 <BLANKLINE>
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1539 '''
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1540 out_pipe = 0
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1541 out_none = 0
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1542 out_devnull = 0
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1543 out_return = None
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1544 out_log = 0
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1545
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1546 outs = out if isinstance(out, list) else [out]
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1547 decoders = dict()
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1548 def decoders_ensure(encoding):
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1549 d = decoders.get(encoding)
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1550 if d is None:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1551 class D:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1552 pass
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1553 d = D()
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1554 # subprocess's universal_newlines and codec.streamreader seem to
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1555 # always use buffering even with bufsize=0, so they don't reliably
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1556 # display prompts or other text that doesn't end with a newline.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1557 #
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1558 # So we create our own incremental decode, which seems to work
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1559 # better.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1560 #
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1561 d.decoder = codecs.getincrementaldecoder(encoding)(errors)
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1562 d.out = ''
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1563 decoders[ encoding] = d
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1564 return d
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1565
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1566 for i, o in enumerate(outs):
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1567 if o is None:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1568 out_none += 1
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1569 elif o == subprocess.DEVNULL:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1570 out_devnull += 1
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1571 else:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1572 out_pipe += 1
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1573 o_prefix = prefix
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1574 if isinstance(o, tuple) and len(o) == 2:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1575 o, o_prefix = o
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1576 assert o not in (None, subprocess.DEVNULL), f'out[]={o} does not make sense with a prefix ({o_prefix})'
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1577 assert not isinstance(o, (tuple, list))
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1578 o_decoder = None
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1579 if o == 'return':
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1580 assert not out_return, f'"return" specified twice does not make sense'
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1581 out_return = io.StringIO()
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1582 o_fn = out_return.write
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1583 elif o == 'log':
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1584 assert not out_log, f'"log" specified twice does not make sense'
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1585 out_log += 1
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1586 out_frame_record = inspect.stack()[caller]
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1587 o_fn = lambda text: log( text, caller=out_frame_record, nv=False, raw=True)
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1588 elif isinstance(o, int):
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1589 def fn(text, o=o):
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1590 os.write(o, text.encode())
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1591 o_fn = fn
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1592 elif callable(o):
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1593 o_fn = o
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1594 else:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1595 assert hasattr(o, 'write') and callable(o.write), (
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1596 f'Do not understand o={o}, must be one of:'
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1597 ' None, subprocess.DEVNULL, "return", "log", <int>,'
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1598 ' or support o() or o.write().'
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1599 )
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1600 o_decoder = decoders_ensure(o.encoding)
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1601 def o_fn(text, o=o):
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1602 if errors == 'strict':
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1603 o.write(text)
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1604 else:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1605 # This is probably only necessary on Windows, where
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1606 # sys.stdout can be cp1252 and will sometimes raise
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1607 # UnicodeEncodeError. We hard-ignore these errors.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1608 try:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1609 o.write(text)
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1610 except Exception as e:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1611 o.write(f'\n[Ignoring Exception: {e}]\n')
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1612 o.flush() # Seems to be necessary on Windows.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1613 if o_prefix:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1614 o_fn = StreamPrefix( o_fn, o_prefix).write
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1615 if not o_decoder:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1616 o_decoder = decoders_ensure(encoding)
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1617 outs[i] = o_fn, o_decoder
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1618
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1619 if out_pipe:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1620 stdout = subprocess.PIPE
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1621 stderr = subprocess.STDOUT
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1622 elif out_none == len(outs):
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1623 stdout = None
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1624 stderr = None
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1625 elif out_devnull == len(outs):
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1626 stdout = subprocess.DEVNULL
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1627 stderr = subprocess.DEVNULL
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1628 else:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1629 assert 0, f'Inconsistent out: {out}'
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1630
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1631 if multiline and '\n' in command:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1632 command = textwrap.dedent(command)
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1633 lines = list()
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1634 for line in command.split( '\n'):
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1635 h = 0 if line.startswith( '#') else line.find(' #')
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1636 if h >= 0:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1637 line = line[:h]
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1638 if line.strip():
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1639 line = line.rstrip()
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1640 lines.append(line)
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1641 sep = ' ' if platform.system() == 'Windows' else ' \\\n'
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1642 command = sep.join(lines)
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1643
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1644 if verbose:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1645 log(f'running: {command_env_text( command, env_extra)}', nv=0, caller=caller+1)
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1646
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1647 env = None
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1648 if env_extra:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1649 env = os.environ.copy()
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1650 env.update(env_extra)
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1651
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1652 child = subprocess.Popen(
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1653 command,
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1654 shell=shell,
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1655 stdin=None,
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1656 stdout=stdout,
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1657 stderr=stderr,
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1658 close_fds=True,
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1659 executable=executable,
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1660 bufsize=bufsize,
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1661 env=env
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1662 )
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1663
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1664 if out_pipe:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1665 while 1:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1666 # os.read() seems to be better for us than child.stdout.read()
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1667 # because it returns a short read if data is not available. Where
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1668 # as child.stdout.read() appears to be more willing to wait for
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1669 # data until the requested number of bytes have been received.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1670 #
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1671 # Also, os.read() does the right thing if the sender has made
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1672 # multiple calls to write() - it returns all available data, not
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1673 # just from the first unread write() call.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1674 #
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1675 output0 = os.read( child.stdout.fileno(), 10000)
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1676 final = not output0
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1677 for _, decoder in decoders.items():
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1678 decoder.out = decoder.decoder.decode(output0, final)
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1679 for o_fn, o_decoder in outs:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1680 o_fn( o_decoder.out)
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1681 if not output0:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1682 break
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1683
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1684 e = child.wait()
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1685
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1686 if out_log:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1687 global _log_text_line_start
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1688 if not _log_text_line_start:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1689 # Terminate last incomplete line of log outputs.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1690 sys.stdout.write('\n')
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1691 _log_text_line_start = True
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1692 if verbose:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1693 log(f'[returned e={e}]', nv=0, caller=caller+1)
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1694
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1695 if out_return:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1696 out_return = out_return.getvalue()
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1697
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1698 if raise_errors:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1699 if e:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1700 message = f'Command failed: {command_env_text( command, env_extra)}'
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1701 if out_return is not None:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1702 if not out_return.endswith('\n'):
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1703 out_return += '\n'
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1704 raise Exception(
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1705 message + '\n'
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1706 + 'Output was:\n'
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1707 + out_return
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1708 )
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1709 else:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1710 raise Exception( message)
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1711 elif out_return is not None:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1712 return out_return
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1713 else:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1714 return
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1715
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1716 if out_return is not None:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1717 return e, out_return
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1718 else:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1719 return e
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1720
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1721
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1722 def system_rusage(
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1723 command,
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1724 verbose=None,
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1725 raise_errors=True,
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1726 out=sys.stdout,
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1727 prefix=None,
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1728 rusage=False,
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1729 shell=True,
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1730 encoding='utf8',
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1731 errors='replace',
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1732 executable=None,
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1733 caller=1,
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1734 bufsize=-1,
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1735 env_extra=None,
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1736 ):
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1737 '''
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1738 Old code that gets timing info; probably doesn't work.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1739 '''
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1740 command2 = ''
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1741 command2 += '/usr/bin/time -o ubt-out -f "D=%D E=%D F=%F I=%I K=%K M=%M O=%O P=%P R=%r S=%S U=%U W=%W X=%X Z=%Z c=%c e=%e k=%k p=%p r=%r s=%s t=%t w=%w x=%x C=%C"'
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1742 command2 += ' '
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1743 command2 += command
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1744
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1745 e = system(
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1746 command2,
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1747 out,
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1748 shell,
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1749 encoding,
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1750 errors,
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1751 executable=executable,
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1752 )
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1753 if e:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1754 raise Exception('/usr/bin/time failed')
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1755 with open('ubt-out') as f:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1756 rusage_text = f.read()
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1757 #print 'have read rusage output: %r' % rusage_text
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1758 if rusage_text.startswith( 'Command '):
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1759 # Annoyingly, /usr/bin/time appears to write 'Command
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1760 # exited with ...' or 'Command terminated by ...' to the
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1761 # output file before the rusage info if command doesn't
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1762 # exit 0.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1763 nl = rusage_text.find('\n')
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1764 rusage_text = rusage_text[ nl+1:]
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1765 return rusage_text
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1766
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1767
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1768 def git_get_files( directory, submodules=False, relative=True):
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1769 '''
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1770 Returns list of all files known to git in `directory`; `directory` must be
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1771 somewhere within a git checkout.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1772
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1773 Returned names are all relative to `directory`.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1774
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1775 If `<directory>.git` exists we use git-ls-files and write list of files to
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1776 `<directory>/jtest-git-files`.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1777
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1778 Otherwise we require that `<directory>/jtest-git-files` already exists.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1779 '''
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1780 def is_within_git_checkout( d):
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1781 while 1:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1782 #log( '{d=}')
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1783 if not d or d=='/':
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1784 break
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1785 if os.path.isdir( f'{d}/.git'):
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1786 return True
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1787 d = os.path.dirname( d)
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1788
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1789 ret = []
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1790 if is_within_git_checkout( directory):
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1791 command = 'cd ' + directory + ' && git ls-files'
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1792 if submodules:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1793 command += ' --recurse-submodules'
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1794 command += ' > jtest-git-files'
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1795 system( command, verbose=False)
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1796 with open( '%s/jtest-git-files' % directory, 'r') as f:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1797 text = f.read()
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1798 for p in text.strip().split( '\n'):
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1799 if not relative:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1800 p = os.path.join( directory, p)
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1801 ret.append( p)
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1802 return ret
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1803
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1804 def git_get_id_raw( directory):
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1805 if not os.path.isdir( '%s/.git' % directory):
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1806 return
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1807 text = system(
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1808 f'cd {directory} && (PAGER= git show --pretty=oneline\|head -n 1 && git diff)',
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1809 out='return',
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1810 )
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1811 return text
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1812
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1813 def git_get_id( directory, allow_none=False):
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1814 '''
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1815 Returns text where first line is '<git-sha> <commit summary>' and remaining
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1816 lines contain output from 'git diff' in <directory>.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1817
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1818 directory:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1819 Root of git checkout.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1820 allow_none:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1821 If true, we return None if `directory` is not a git checkout and
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1822 jtest-git-id file does not exist.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1823 '''
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1824 filename = f'{directory}/jtest-git-id'
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1825 text = git_get_id_raw( directory)
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1826 if text:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1827 with open( filename, 'w') as f:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1828 f.write( text)
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1829 elif os.path.isfile( filename):
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1830 with open( filename) as f:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1831 text = f.read()
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1832 else:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1833 if not allow_none:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1834 raise Exception( f'Not in git checkout, and no file called: {filename}.')
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1835 text = None
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1836 return text
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1837
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1838 class Args:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1839 '''
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1840 Iterates over argv items.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1841 '''
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1842 def __init__( self, argv):
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1843 self.items = iter( argv)
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1844 def next( self):
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1845 if sys.version_info[0] == 3:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1846 return next( self.items)
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1847 else:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1848 return self.items.next()
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1849 def next_or_none( self):
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1850 try:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1851 return self.next()
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1852 except StopIteration:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1853 return None
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1854
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1855
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1856 def fs_read( path, binary=False):
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1857 with open( path, 'rb' if binary else 'r') as f:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1858 return f.read()
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1859
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1860 def fs_write( path, data, binary=False):
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1861 with open( path, 'wb' if binary else 'w') as f:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1862 return f.write( data)
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1863
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1864
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1865 def fs_update( text, filename, return_different=False):
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1866 '''
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1867 Writes `text` to `filename`. Does nothing if contents of `filename` are
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1868 already `text`.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1869
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1870 If `return_different` is true, we return existing contents if `filename`
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1871 already exists and differs from `text`.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1872
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1873 Otherwise we return true if file has changed.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1874 '''
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1875 try:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1876 with open( filename) as f:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1877 text0 = f.read()
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1878 except OSError:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1879 text0 = None
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1880 if text != text0:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1881 if return_different and text0 is not None:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1882 return text
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1883 # Write to temp file and rename, to ensure we are atomic.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1884 filename_temp = f'{filename}-jlib-temp'
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1885 with open( filename_temp, 'w') as f:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1886 f.write( text)
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1887 fs_rename( filename_temp, filename)
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1888 return True
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1889
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1890
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1891 def fs_find_in_paths( name, paths=None, verbose=False):
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1892 '''
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1893 Looks for `name` in paths and returns complete path. `paths` is list/tuple
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1894 or `os.pathsep`-separated string; if `None` we use `$PATH`. If `name`
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1895 contains `/`, we return `name` itself if it is a file, regardless of $PATH.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1896 '''
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1897 if '/' in name:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1898 return name if os.path.isfile( name) else None
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1899 if paths is None:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1900 paths = os.environ.get( 'PATH', '')
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1901 if verbose:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1902 log('From os.environ["PATH"]: {paths=}')
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1903 if isinstance( paths, str):
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1904 paths = paths.split( os.pathsep)
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1905 if verbose:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1906 log('After split: {paths=}')
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1907 for path in paths:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1908 p = os.path.join( path, name)
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1909 if verbose:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1910 log('Checking {p=}')
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1911 if os.path.isfile( p):
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1912 if verbose:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1913 log('Returning because is file: {p!r}')
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1914 return p
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1915 if verbose:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1916 log('Returning None because not found: {name!r}')
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1917
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1918
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1919 def fs_mtime( filename, default=0):
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1920 '''
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1921 Returns mtime of file, or `default` if error - e.g. doesn't exist.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1922 '''
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1923 try:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1924 return os.path.getmtime( filename)
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1925 except OSError:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1926 return default
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1927
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1928
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1929 def fs_filesize( filename, default=0):
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1930 try:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1931 return os.path.getsize( filename)
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1932 except OSError:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1933 return default
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1934
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1935
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1936 def fs_paths( paths):
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1937 '''
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1938 Yields each file in `paths`, walking any directories.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1939
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1940 If `paths` is a tuple `(paths2, filter_)` and `filter_` is callable, we
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1941 yield all files in `paths2` for which `filter_(path2)` returns true.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1942 '''
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1943 filter_ = lambda path: True
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1944 if isinstance( paths, tuple) and len( paths) == 2 and callable( paths[1]):
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1945 paths, filter_ = paths
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1946 if isinstance( paths, str):
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1947 paths = (paths,)
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1948 for name in paths:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1949 if os.path.isdir( name):
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1950 for dirpath, dirnames, filenames in os.walk( name):
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1951 for filename in filenames:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1952 path = os.path.join( dirpath, filename)
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1953 if filter_( path):
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1954 yield path
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1955 else:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1956 if filter_( name):
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1957 yield name
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1958
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1959 def fs_remove( path, backup=False):
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1960 '''
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1961 Removes file or directory, without raising exception if it doesn't exist.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1962
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1963 path:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1964 The path to remove.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1965 backup:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1966 If true, we rename any existing file/directory called `path` to
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1967 `<path>-<datetime>`.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1968
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1969 We assert-fail if the path still exists when we return, in case of
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1970 permission problems etc.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1971 '''
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1972 if backup and os.path.exists( path):
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1973 datetime = date_time()
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1974 if platform.system() == 'Windows' or platform.system().startswith( 'CYGWIN'):
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1975 # os.rename() fails if destination contains colons, with:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1976 # [WinError87] The parameter is incorrect ...
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1977 datetime = datetime.replace( ':', '')
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1978 p = f'{path}-{datetime}'
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1979 log( 'Moving out of way: {path} => {p}')
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1980 os.rename( path, p)
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1981 try:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1982 os.remove( path)
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1983 except Exception:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1984 pass
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1985 shutil.rmtree( path, ignore_errors=1)
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1986 assert not os.path.exists( path)
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1987
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1988 def fs_remove_dir_contents( path):
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1989 '''
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1990 Removes all items in directory `path`; does not remove `path` itself.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1991 '''
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1992 for leaf in os.listdir( path):
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1993 path2 = os.path.join( path, leaf)
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1994 fs_remove(path2)
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1995
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1996 def fs_ensure_empty_dir( path):
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1997 os.makedirs( path, exist_ok=True)
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1998 fs_remove_dir_contents( path)
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1999
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2000 def fs_rename(src, dest):
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2001 '''
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2002 Renames `src` to `dest`. If we get an error, we try to remove `dest`
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2003 explicitly and then retry; this is to make things work on Windows.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2004 '''
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2005 try:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2006 os.rename(src, dest)
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2007 except Exception:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2008 os.remove(dest)
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2009 os.rename(src, dest)
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2010
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2011 def fs_copy(src, dest, verbose=False):
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2012 '''
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2013 Wrapper for `shutil.copy()` that also ensures parent of `dest` exists and
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2014 optionally calls `jlib.log()` with diagnostic.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2015 '''
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2016 if verbose:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2017 log('Copying {src} to {dest}')
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2018 dirname = os.path.dirname(dest)
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2019 if dirname:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2020 os.makedirs( dirname, exist_ok=True)
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2021 shutil.copy2( src, dest)
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2022
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2023
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2024 def untar(path, mode='r:gz', prefix=None):
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2025 '''
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2026 Extracts tar file.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2027
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2028 We fail if items in tar file have different top-level directory names, or
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2029 if tar file's top-level directory name already exists locally.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2030
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2031 path:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2032 The tar file.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2033 mode:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2034 As `tarfile.open()`.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2035 prefix:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2036 If not `None`, we fail if tar file's top-level directory name is not
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2037 `prefix`.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2038
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2039 Returns the directory name (which will be `prefix` if not `None`).
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2040 '''
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2041 with tarfile.open( path, mode) as t:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2042 items = t.getnames()
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2043 assert items
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2044 item = items[0]
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2045 assert not item.startswith('.')
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2046 s = item.find('/')
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2047 if s == -1:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2048 prefix_actual = item + '/'
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2049 else:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2050 prefix_actual = item[:s+1]
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2051 if prefix:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2052 assert prefix == prefix_actual, f'prefix={prefix} prefix_actual={prefix_actual}'
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2053 for item in items[1:]:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2054 assert item.startswith( prefix_actual), f'prefix_actual={prefix_actual!r} != item={item!r}'
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2055 assert not os.path.exists( prefix_actual)
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2056 t.extractall()
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2057 return prefix_actual
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2058
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2059
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2060 # Things for figuring out whether files need updating, using mtimes.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2061 #
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2062 def fs_newest( names):
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2063 '''
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2064 Returns mtime of newest file in `filenames`. Returns 0 if no file exists.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2065 '''
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2066 assert isinstance( names, (list, tuple))
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2067 assert names
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2068 ret_t = 0
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2069 ret_name = None
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2070 for filename in fs_paths( names):
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2071 if filename.endswith('.pyc'):
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2072 continue
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2073 t = fs_mtime( filename)
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2074 if t > ret_t:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2075 ret_t = t
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2076 ret_name = filename
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2077 return ret_t, ret_name
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2078
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2079 def fs_oldest( names):
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2080 '''
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2081 Returns mtime of oldest file in `filenames` or 0 if no file exists.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2082 '''
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2083 assert isinstance( names, (list, tuple))
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2084 assert names
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2085 ret_t = None
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2086 ret_name = None
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2087 for filename in fs_paths( names):
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2088 t = fs_mtime( filename)
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2089 if ret_t is None or t < ret_t:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2090 ret_t = t
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2091 ret_name = filename
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2092 if ret_t is None:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2093 ret_t = 0
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2094 return ret_t, ret_name
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2095
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2096 def fs_any_newer( infiles, outfiles):
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2097 '''
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2098 If any file in `infiles` is newer than any file in `outfiles`, returns
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2099 string description. Otherwise returns `None`.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2100 '''
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2101 in_tmax, in_tmax_name = fs_newest( infiles)
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2102 out_tmin, out_tmin_name = fs_oldest( outfiles)
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2103 if in_tmax > out_tmin:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2104 text = f'{in_tmax_name} is newer than {out_tmin_name}'
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2105 return text
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2106
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2107 def fs_ensure_parent_dir( path):
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2108 parent = os.path.dirname( path)
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2109 if parent:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2110 os.makedirs( parent, exist_ok=True)
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2111
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2112 def fs_newer( pattern, t):
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2113 '''
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2114 Returns list of files matching glob `pattern` whose mtime is >= `t`.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2115 '''
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2116 paths = glob.glob(pattern)
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2117 paths_new = []
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2118 for path in paths:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2119 tt = fs_mtime(path)
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2120 if tt >= t:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2121 paths_new.append(path)
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2122 return paths_new
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2123
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2124 def build(
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2125 infiles,
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2126 outfiles,
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2127 command,
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2128 force_rebuild=False,
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2129 out=None,
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2130 all_reasons=False,
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2131 verbose=True,
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2132 executable=None,
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2133 ):
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2134 '''
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2135 Ensures that `outfiles` are up to date using enhanced makefile-like
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2136 determinism of dependencies.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2137
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2138 Rebuilds `outfiles` by running `command` if we determine that any of them
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2139 are out of date, or if `command` has changed.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2140
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2141 infiles:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2142 Names of files that are read by `command`. Can be a single filename. If
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2143 an item is a directory, we expand to all filenames in the directory's
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2144 tree. Can be `(files2, filter_)` as supported by `jlib.fs_paths()`.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2145 outfiles:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2146 Names of files that are written by `command`. Can also be a single
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2147 filename. Can be `(files2, filter_)` as supported by `jlib.fs_paths()`.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2148 command:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2149 Command to run. {IN} and {OUT} are replaced by space-separated
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2150 `infiles` and `outfiles` with '/' changed to '\' on Windows.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2151 force_rebuild:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2152 If true, we always re-run the command.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2153 out:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2154 A callable, passed to `jlib.system()`. If `None`, we use `jlib.log()`
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2155 with our caller's stack record (by passing `(out='log', caller=2)` to
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2156 `jlib.system()`).
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2157 all_reasons:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2158 If true we check all ways for a build being needed, even if we already
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2159 know a build is needed; this only affects the diagnostic that we
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2160 output.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2161 verbose:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2162 Passed to `jlib.system()`.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2163
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2164 Returns:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2165 true if we have run the command, otherwise None.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2166
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2167 We compare mtimes of `infiles` and `outfiles`, and we also detect changes
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2168 to the command itself.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2169
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2170 If any of infiles are newer than any of `outfiles`, or `command` is
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2171 different to contents of commandfile `<outfile[0]>.cmd`, then truncates
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2172 commandfile and runs `command`. If `command` succeeds we writes `command`
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2173 to commandfile.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2174 '''
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2175 if isinstance( infiles, str):
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2176 infiles = (infiles,)
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2177 if isinstance( outfiles, str):
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2178 outfiles = (outfiles,)
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2179
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2180 if out is None:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2181 out = 'log'
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2182
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2183 command_filename = f'{outfiles[0]}.cmd'
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2184 reasons = []
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2185
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2186 if not reasons or all_reasons:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2187 if force_rebuild:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2188 reasons.append( 'force_rebuild was specified')
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2189
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2190 os_name = platform.system()
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2191 os_windows = (os_name == 'Windows' or os_name.startswith('CYGWIN'))
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2192 def files_string(files):
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2193 if isinstance(files, tuple) and len(files) == 2 and callable(files[1]):
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2194 files = files[0],
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2195 ret = ' '.join(files)
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2196 if os_windows:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2197 # This works on Cygwyn; we might only need '\\' if running in a Cmd
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2198 # window.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2199 ret = ret.replace('/', '\\\\')
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2200 return ret
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2201 command = command.replace('{IN}', files_string(infiles))
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2202 command = command.replace('{OUT}', files_string(outfiles))
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2203
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2204 if not reasons or all_reasons:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2205 try:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2206 with open( command_filename) as f:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2207 command0 = f.read()
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2208 except Exception:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2209 command0 = None
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2210 if command != command0:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2211 reasons.append( f'command has changed:\n{command0}\n=>\n{command}')
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2212
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2213 if not reasons or all_reasons:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2214 reason = fs_any_newer( infiles, outfiles)
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2215 if reason:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2216 reasons.append( reason)
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2217
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2218 if not reasons:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2219 log( 'Already up to date: ' + ' '.join(outfiles), caller=2, nv=0)
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2220 return
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2221
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2222 log( f'Rebuilding because {", and ".join(reasons)}: {" ".join(outfiles)}',
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2223 caller=2,
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2224 nv=0,
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2225 )
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2226
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2227 # Empty <command_filename) while we run the command so that if command
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2228 # fails but still creates target(s), then next time we will know target(s)
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2229 # are not up to date.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2230 #
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2231 # We rename the command to a temporary file and then rename back again
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2232 # after the command finishes so that its mtime is unchanged if the command
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2233 # has not changed.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2234 #
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2235 fs_ensure_parent_dir( command_filename)
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2236 command_filename_temp = command_filename + '-'
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2237 fs_remove(command_filename_temp)
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2238 if os.path.exists( command_filename):
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2239 fs_rename(command_filename, command_filename_temp)
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2240 fs_update( command, command_filename_temp)
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2241 assert os.path.isfile( command_filename_temp)
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2242
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2243 system( command, out=out, verbose=verbose, executable=executable, caller=2)
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2244
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2245 assert os.path.isfile( command_filename_temp), \
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2246 f'Command seems to have deleted {command_filename_temp=}: {command!r}'
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2247
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2248 fs_rename( command_filename_temp, command_filename)
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2249
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2250 return True
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2251
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2252
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2253 def link_l_flags( sos, ld_origin=None):
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2254 '''
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2255 Returns link flags suitable for linking with each .so in <sos>.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2256
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2257 We return -L flags for each unique parent directory and -l flags for each
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2258 leafname.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2259
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2260 In addition on non-Windows we append " -Wl,-rpath,'$ORIGIN,-z,origin"
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2261 so that libraries will be searched for next to each other. This can be
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2262 disabled by setting ld_origin to false.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2263 '''
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2264 darwin = (platform.system() == 'Darwin')
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2265 dirs = set()
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2266 names = []
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2267 if isinstance( sos, str):
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2268 sos = [sos]
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2269 ret = ''
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2270 for so in sos:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2271 if not so:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2272 continue
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2273 dir_ = os.path.dirname( so)
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2274 name = os.path.basename( so)
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2275 assert name.startswith( 'lib'), f'name={name}'
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2276 m = re.search( '(.so[.0-9]*)$', name)
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2277 if m:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2278 l = len(m.group(1))
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2279 dirs.add( dir_)
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2280 names.append( f'-l {name[3:-l]}')
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2281 elif darwin and name.endswith( '.dylib'):
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2282 dirs.add( dir_)
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2283 names.append( f'-l {name[3:-6]}')
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2284 elif name.endswith( '.a'):
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2285 names.append( so)
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2286 else:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2287 assert 0, f'leaf does not end in .so or .a: {so}'
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2288 ret = ''
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2289 # Important to use sorted() here, otherwise ordering from set() is
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2290 # arbitrary causing occasional spurious rebuilds.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2291 for dir_ in sorted(dirs):
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2292 ret += f' -L {os.path.relpath(dir_)}'
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2293 for name in names:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2294 ret += f' {name}'
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2295 if ld_origin is None:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2296 if platform.system() != 'Windows':
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2297 ld_origin = True
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2298 if ld_origin:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2299 if darwin:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2300 # As well as this link flag, it is also necessary to use
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2301 # `install_name_tool -change` to rename internal names to
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2302 # `@rpath/<leafname>`.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2303 ret += ' -Wl,-rpath,@loader_path/.'
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2304 else:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2305 ret += " -Wl,-rpath,'$ORIGIN',-z,origin"
12 fdb709369d57 Do not use -z,relro,-z,now on Systems where it is not supported. Franz Glasner <fzglas.hg@dom66.de> parents: 7 diff changeset	2306 if not darwin and (platform.system() != 'Windows'):
fdb709369d57 Do not use -z,relro,-z,now on Systems where it is not supported. Franz Glasner <fzglas.hg@dom66.de> parents: 7 diff changeset	2307 # *BSD and Linux
fdb709369d57 Do not use -z,relro,-z,now on Systems where it is not supported. Franz Glasner <fzglas.hg@dom66.de> parents: 7 diff changeset	2308 # Full RELRO
fdb709369d57 Do not use -z,relro,-z,now on Systems where it is not supported. Franz Glasner <fzglas.hg@dom66.de> parents: 7 diff changeset	2309 ret += ' -Wl,-z,relro,-z,now'
fdb709369d57 Do not use -z,relro,-z,now on Systems where it is not supported. Franz Glasner <fzglas.hg@dom66.de> parents: 7 diff changeset	2310 # Strip
fdb709369d57 Do not use -z,relro,-z,now on Systems where it is not supported. Franz Glasner <fzglas.hg@dom66.de> parents: 7 diff changeset	2311 ret += ' -Wl,-s'
2 b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2312 #log('{sos=} {ld_origin=} {ret=}')
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2313 return ret.strip()

Mercurial > hgrepos > Python2 > PyMuPDF

annotate mupdf-source/scripts/jlib.py @ 38:8934ac156ef5