Python2/PyMuPDF: setup.py annotate

author	Franz Glasner <fzglas.hg@dom66.de>
date	Mon, 15 Sep 2025 11:37:51 +0200
parents
children	5ab937c03c27 a6bc019ac0b2

rev	line source
1 1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1 #! /usr/bin/env python3
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	3 '''
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	4 Overview:
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	5
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	6 Build script for PyMuPDF, supporting PEP-517 and simple command-line usage.
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	7
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	8 We hard-code the URL of the MuPDF .tar.gz file that we require. This
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	9 generally points to a particular source release on mupdf.com.
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	10
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	11 Default behaviour:
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	12
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	13 Building an sdist:
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	14 As of 2024-002-28 we no longer download the MuPDF .tar.gz file and
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	15 embed it within the sdist. Instead it will be downloaded at build
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	16 time.
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	17
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	18 Building PyMuPDF:
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	19 We first download the hard-coded mupdf .tar.gz file.
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	20
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	21 Then we extract and build MuPDF locally, before building PyMuPDF
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	22 itself. So PyMuPDF will always be built with the exact MuPDF
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	23 release that we require.
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	24
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	25
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	26 Environmental variables:
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	27
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	28 If building with system MuPDF (PYMUPDF_SETUP_MUPDF_BUILD is empty string):
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	29
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	30 CFLAGS
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	31 CXXFLAGS
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	32 LDFLAGS
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	33 Added to c, c++, and link commands.
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	34
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	35 PYMUPDF_INCLUDES
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	36 Colon-separated extra include paths.
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	37
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	38 PYMUPDF_MUPDF_LIB
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	39 Directory containing MuPDF libraries, (libmupdf.so,
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	40 libmupdfcpp.so).
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	41
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	42 PYMUPDF_SETUP_DEVENV
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	43 Location of devenv.com on Windows. If unset we search for it - see
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	44 wdev.py. if that fails we use just 'devenv.com'.
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	45
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	46 PYMUPDF_SETUP_DUMMY
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	47 If 1, we build dummy sdist and wheel with no files.
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	48
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	49 PYMUPDF_SETUP_FLAVOUR
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	50 Control building of separate wheels for PyMuPDF.
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	51
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	52 Must be unset or a combination of 'p', 'b' and 'd'.
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	53
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	54 Default is 'pbd'.
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	55
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	56 'p':
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	57 Generated wheel contains PyMuPDF code.
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	58 'b':
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	59 Generated wheel contains MuPDF libraries; these are independent of
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	60 the Python version.
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	61 'd':
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	62 Generated wheel contains includes and libraries for MuPDF.
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	63
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	64 If 'p' is included, the generated wheel is called PyMuPDF.
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	65 Otherwise if 'b' is included the generated wheel is called PyMuPDFb.
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	66 Otherwise if 'd' is included the generated wheel is called PyMuPDFd.
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	67
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	68 For example:
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	69
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	70 'pb': a `PyMuPDF` wheel with PyMuPDF runtime files and MuPDF
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	71 runtime shared libraries.
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	72
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	73 'b': a `PyMuPDFb` wheel containing MuPDF runtime shared libraries.
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	74
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	75 'pbd' a `PyMuPDF` wheel with PyMuPDF runtime files and MuPDF
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	76 runtime shared libraries, plus MuPDF build-time files (includes,
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	77 *.lib files on Windows).
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	78
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	79 'd': a `PyMuPDFd` wheel containing MuPDF build-time files
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	80 (includes, *.lib files on Windows).
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	81
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	82 PYMUPDF_SETUP_LIBCLANG
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	83 For internal testing.
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	84
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	85 PYMUPDF_SETUP_MUPDF_BUILD
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	86 If unset or '-', use internal hard-coded default MuPDF location.
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	87 Otherwise overrides location of MuPDF when building PyMuPDF:
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	88 Empty string:
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	89 Build PyMuPDF with the system MuPDF.
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	90 A string starting with 'git:':
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	91 Use `git clone` to get a MuPDF checkout. We use the
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	92 string in the git clone command; it must contain the git
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	93 URL from which to clone, and can also contain other `git
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	94 clone` args, for example:
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	95 PYMUPDF_SETUP_MUPDF_BUILD="git:--branch master https://github.com/ArtifexSoftware/mupdf.git"
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	96 Otherwise:
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	97 Location of mupdf directory.
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	98
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	99 PYMUPDF_SETUP_MUPDF_BSYMBOLIC
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	100 If '0' we do not link libmupdf.so with -Bsymbolic.
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	101
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	102 PYMUPDF_SETUP_MUPDF_TESSERACT
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	103 If '0' we build MuPDF without Tesseract.
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	104
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	105 PYMUPDF_SETUP_MUPDF_BUILD_TYPE
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	106 Unix only. Controls build type of MuPDF. Supported values are:
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	107 debug
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	108 memento
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	109 release (default)
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	110
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	111 PYMUPDF_SETUP_MUPDF_CLEAN
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	112 Unix only. If '1', we do a clean MuPDF build.
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	113
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	114 PYMUPDF_SETUP_MUPDF_REFCHECK_IF
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	115 Should be preprocessor statement to enable MuPDF reference count
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	116 checking.
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	117
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	118 As of 2024-09-27, MuPDF default is `#ifndef NDEBUG`.
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	119
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	120 PYMUPDF_SETUP_MUPDF_TRACE_IF
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	121 Should be preprocessor statement to enable MuPDF runtime diagnostics in
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	122 response to environment variables such as MUPDF_trace.
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	123
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	124 As of 2024-09-27, MuPDF default is `#ifndef NDEBUG`.
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	125
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	126 PYMUPDF_SETUP_MUPDF_THIRD
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	127 If '0' and we are building on Linux with the system MuPDF
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	128 (i.e. PYMUPDF_SETUP_MUPDF_BUILD=''), then don't link with
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	129 `-lmupdf-third`.
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	130
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	131 PYMUPDF_SETUP_MUPDF_VS_UPGRADE
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	132 If '1' we run mupdf `scripts/mupdfwrap.py` with `--vs-upgrade 1` to
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	133 help Windows builds work with Visual Studio versions newer than 2019.
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	134
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	135 PYMUPDF_SETUP_MUPDF_TGZ
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	136 If set, overrides location of MuPDF .tar.gz file:
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	137 Empty string:
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	138 Do not download MuPDF .tar.gz file. Sdist's will not contain
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	139 MuPDF.
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	140
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	141 A string containing '://':
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	142 The URL from which to download the MuPDF .tar.gz file. Leaf
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	143 must match mupdf-*.tar.gz.
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	144
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	145 Otherwise:
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	146 The path of local mupdf git checkout. We put all files in this
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	147 checkout known to git into a local tar archive.
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	148
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	149 PYMUPDF_SETUP_MUPDF_OVERWRITE_CONFIG
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	150 If '0' we do not overwrite MuPDF's include/mupdf/fitz/config.h with
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	151 PyMuPDF's own configuration file, before building MuPDF.
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	152
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	153 PYMUPDF_SETUP_MUPDF_REBUILD
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	154 If 0 we do not (re)build mupdf.
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	155
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	156 PYMUPDF_SETUP_PY_LIMITED_API
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	157 If not '0', we build for current Python's stable ABI.
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	158
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	159 However if unset and we are on Python-3.13 or later, we do
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	160 not build for the stable ABI because as of 2025-03-04 SWIG
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	161 generates incorrect stable ABI code with Python-3.13 - see:
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	162 https://github.com/swig/swig/issues/3059
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	163
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	164 PYMUPDF_SETUP_URL_WHEEL
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	165 If set, we use an existing wheel instead of building a new wheel.
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	166
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	167 If starts with `http://` or `https://`:
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	168 If ends with '/', we append our wheel name and download. Otherwise
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	169 we download directly.
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	170
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	171 If starts with `file://`:
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	172 If ends with '/' we look for a matching wheel name, `using
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	173 pipcl.wheel_name_match()` to cope with differing platform tags,
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	174 for example our `manylinux2014_x86_64` will match with an existing
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	175 wheel with `manylinux2014_x86_64.manylinux_2_17_x86_64`.
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	176
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	177 Any other prefix is an error.
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	178
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	179 PYMUPDF_SETUP_SWIG
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	180 If set, we use this instead of `swig`.
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	181
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	182 WDEV_VS_YEAR
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	183 If set, we use as Visual Studio year, for example '2019' or '2022'.
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	184
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	185 WDEV_VS_GRADE
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	186 If set, we use as Visual Studio grade, for example 'Community' or
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	187 'Professional' or 'Enterprise'.
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	188 '''
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	189
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	190 import glob
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	191 import io
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	192 import os
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	193 import textwrap
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	194 import time
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	195 import platform
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	196 import re
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	197 import shlex
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	198 import shutil
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	199 import stat
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	200 import subprocess
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	201 import sys
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	202 import tarfile
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	203 import traceback
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	204 import urllib.request
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	205 import zipfile
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	206
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	207 import pipcl
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	208
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	209
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	210 log = pipcl.log0
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	211
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	212 run = pipcl.run
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	213
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	214
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	215 if 1:
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	216 # For debugging.
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	217 log(f'### Starting.')
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	218 pipcl.show_system()
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	219
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	220
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	221 PYMUPDF_SETUP_FLAVOUR = os.environ.get( 'PYMUPDF_SETUP_FLAVOUR', 'pbd')
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	222 for i in PYMUPDF_SETUP_FLAVOUR:
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	223 assert i in 'pbd', f'Unrecognised flag "{i} in {PYMUPDF_SETUP_FLAVOUR=}. Should be one of "p", "b", "d"'
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	224
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	225 g_root = os.path.abspath( f'{__file__}/..')
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	226
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	227 # Name of file that identifies that we are in a PyMuPDF sdist.
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	228 g_pymupdfb_sdist_marker = 'pymupdfb_sdist'
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	229
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	230 python_version_tuple = tuple(int(x) for x in platform.python_version_tuple()[:2])
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	231
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	232 PYMUPDF_SETUP_PY_LIMITED_API = os.environ.get('PYMUPDF_SETUP_PY_LIMITED_API')
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	233 assert PYMUPDF_SETUP_PY_LIMITED_API in (None, '', '0', '1'), \
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	234 f'Should be "", "0", "1" or undefined: {PYMUPDF_SETUP_PY_LIMITED_API=}.'
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	235 if PYMUPDF_SETUP_PY_LIMITED_API is None and python_version_tuple >= (3, 13):
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	236 log(f'Not defaulting to Python limited api because {platform.python_version_tuple()=}.')
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	237 g_py_limited_api = False
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	238 else:
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	239 g_py_limited_api = (PYMUPDF_SETUP_PY_LIMITED_API != '0')
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	240
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	241 PYMUPDF_SETUP_URL_WHEEL = os.environ.get('PYMUPDF_SETUP_URL_WHEEL')
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	242 log(f'{PYMUPDF_SETUP_URL_WHEEL=}')
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	243
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	244 PYMUPDF_SETUP_DUMMY = os.environ.get('PYMUPDF_SETUP_DUMMY')
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	245 log(f'{PYMUPDF_SETUP_DUMMY=}')
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	246
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	247 PYMUPDF_SETUP_SWIG = os.environ.get('PYMUPDF_SETUP_SWIG')
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	248
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	249 def _fs_remove(path):
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	250 '''
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	251 Removes file or directory, without raising exception if it doesn't exist.
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	252
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	253 We assert-fail if the path still exists when we return, in case of
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	254 permission problems etc.
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	255 '''
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	256 # First try deleting `path` as a file.
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	257 try:
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	258 os.remove( path)
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	259 except Exception as e:
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	260 pass
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	261
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	262 if os.path.exists(path):
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	263 # Try deleting `path` as a directory. Need to use
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	264 # shutil.rmtree() callback to handle permission problems; see:
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	265 # https://docs.python.org/3/library/shutil.html#rmtree-example
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	266 #
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	267 def error_fn(fn, path, excinfo):
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	268 # Clear the readonly bit and reattempt the removal.
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	269 os.chmod(path, stat.S_IWRITE)
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	270 fn(path)
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	271 shutil.rmtree( path, onerror=error_fn)
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	272
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	273 assert not os.path.exists( path)
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	274
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	275
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	276 def _git_get_branch( directory):
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	277 command = f'cd {directory} && git branch --show-current'
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	278 log( f'Running: {command}')
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	279 p = subprocess.run(
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	280 command,
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	281 shell=True,
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	282 check=False,
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	283 text=True,
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	284 stdout=subprocess.PIPE,
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	285 )
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	286 ret = None
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	287 if p.returncode == 0:
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	288 ret = p.stdout.strip()
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	289 log( f'Have found MuPDF git branch: ret={ret!r}')
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	290 return ret
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	291
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	292
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	293 def tar_check(path, mode='r:gz', prefix=None, remove=False):
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	294 '''
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	295 Checks items in tar file have same <top-directory>, or <prefix> if not None.
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	296
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	297 We fail if items in tar file have different top-level directory names.
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	298
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	299 path:
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	300 The tar file.
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	301 mode:
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	302 As tarfile.open().
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	303 prefix:
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	304 If not None, we fail if tar file's <top-directory> is not <prefix>.
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	305
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	306 Returns the directory name (which will be <prefix> if not None).
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	307 '''
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	308 with tarfile.open( path, mode) as t:
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	309 items = t.getnames()
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	310 assert items
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	311 item = items[0]
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	312 assert not item.startswith('./') and not item.startswith('../')
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	313 s = item.find('/')
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	314 if s == -1:
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	315 prefix_actual = item + '/'
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	316 else:
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	317 prefix_actual = item[:s+1]
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	318 if prefix:
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	319 assert prefix == prefix_actual, f'{path=} {prefix=} {prefix_actual=}'
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	320 for item in items[1:]:
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	321 assert item.startswith( prefix_actual), f'prefix_actual={prefix_actual!r} != item={item!r}'
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	322 return prefix_actual
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	323
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	324
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	325 def tar_extract(path, mode='r:gz', prefix=None, exists='raise'):
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	326 '''
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	327 Extracts tar file into single local directory.
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	328
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	329 We fail if items in tar file have different <top-directory>.
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	330
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	331 path:
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	332 The tar file.
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	333 mode:
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	334 As tarfile.open().
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	335 prefix:
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	336 If not None, we fail if tar file's <top-directory> is not <prefix>.
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	337 exists:
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	338 What to do if <top-directory> already exists:
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	339 'raise': raise exception.
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	340 'remove': remove existing file/directory before extracting.
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	341 'return': return without extracting.
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	342
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	343 Returns the directory name (which will be <prefix> if not None, with '/'
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	344 appended if not already present).
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	345 '''
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	346 prefix_actual = tar_check( path, mode, prefix)
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	347 if os.path.exists( prefix_actual):
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	348 if exists == 'raise':
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	349 raise Exception( f'Path already exists: {prefix_actual!r}')
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	350 elif exists == 'remove':
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	351 remove( prefix_actual)
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	352 elif exists == 'return':
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	353 log( f'Not extracting {path} because already exists: {prefix_actual}')
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	354 return prefix_actual
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	355 else:
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	356 assert 0, f'Unrecognised exists={exists!r}'
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	357 assert not os.path.exists( prefix_actual), f'Path already exists: {prefix_actual}'
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	358 log( f'Extracting {path}')
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	359 with tarfile.open( path, mode) as t:
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	360 t.extractall()
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	361 return prefix_actual
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	362
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	363
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	364 def git_info( directory):
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	365 '''
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	366 Returns `(sha, comment, diff, branch)`, all items are str or None if not
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	367 available.
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	368
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	369 directory:
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	370 Root of git checkout.
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	371 '''
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	372 sha, comment, diff, branch = '', '', '', ''
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	373 cp = subprocess.run(
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	374 f'cd {directory} && (PAGER= git show --pretty=oneline\|head -n 1 && git diff)',
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	375 capture_output=1,
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	376 shell=1,
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	377 text=1,
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	378 )
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	379 if cp.returncode == 0:
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	380 sha, _ = cp.stdout.split(' ', 1)
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	381 comment, diff = _.split('\n', 1)
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	382 cp = subprocess.run(
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	383 f'cd {directory} && git rev-parse --abbrev-ref HEAD',
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	384 capture_output=1,
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	385 shell=1,
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	386 text=1,
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	387 )
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	388 if cp.returncode == 0:
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	389 branch = cp.stdout.strip()
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	390 log(f'git_info(): directory={directory!r} returning branch={branch!r} sha={sha!r} comment={comment!r}')
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	391 return sha, comment, diff, branch
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	392
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	393
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	394 def git_patch(directory, patch, hard=False):
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	395 '''
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	396 Applies string <patch> with `git patch` in <directory>.
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	397
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	398 If <hard> is true we clean the tree with `git checkout .` and then apply
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	399 the patch.
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	400
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	401 Otherwise we apply patch only if it is not already applied; this might fail
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	402 if there are conflicting changes in the tree.
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	403 '''
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	404 log(f'Applying patch in {directory}:\n{textwrap.indent(patch, " ")}')
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	405 if not patch:
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	406 return
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	407 # Carriage returns break `git apply` so we use `newline='\n'` in open().
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	408 path = os.path.abspath(f'{directory}/pymupdf_patch.txt')
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	409 with open(path, 'w', newline='\n') as f:
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	410 f.write(patch)
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	411 log(f'Using patch file: {path}')
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	412 if hard:
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	413 run(f'cd {directory} && git checkout .')
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	414 run(f'cd {directory} && git apply {path}')
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	415 log(f'Have applied patch in {directory}.')
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	416 else:
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	417 e = run( f'cd {directory} && git apply --check --reverse {path}', check=0)
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	418 if e == 0:
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	419 log(f'Not patching {directory} because already patched.')
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	420 else:
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	421 run(f'cd {directory} && git apply {path}')
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	422 log(f'Have applied patch in {directory}.')
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	423 run(f'cd {directory} && git diff')
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	424
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	425
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	426 mupdf_tgz = os.path.abspath( f'{__file__}/../mupdf.tgz')
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	427
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	428 def get_mupdf_internal(out, location=None, sha=None, local_tgz=None):
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	429 '''
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	430 Gets MuPDF as either a .tgz or a local directory.
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	431
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	432 Args:
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	433 out:
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	434 Either 'dir' (we return name of local directory containing mupdf) or 'tgz' (we return
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	435 name of local .tgz file containing mupdf).
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	436 location:
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	437 First, if None we set to hard-coded default URL or git location.
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	438 If starts with 'git:', should be remote git location.
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	439 Otherwise if containing '://' should be URL for .tgz.
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	440 Otherwise should path of local mupdf checkout.
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	441 sha:
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	442 If not None and we use git clone, we checkout this sha.
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	443 local_tgz:
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	444 If not None, must be local .tgz file.
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	445 Returns:
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	446 (path, location):
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	447 `path` is absolute path of local directory or .tgz containing
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	448 MuPDF, or None if we are to use system MuPDF.
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	449
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	450 `location_out` is `location` if not None, else the hard-coded
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	451 default location.
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	452
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	453 '''
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	454 log(f'get_mupdf_internal(): {out=} {location=} {sha=}')
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	455 assert out in ('dir', 'tgz')
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	456 if location is None:
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	457 location = f'https://mupdf.com/downloads/archive/mupdf-{version_mupdf}-source.tar.gz'
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	458 #location = 'git:--branch master https://github.com/ArtifexSoftware/mupdf.git'
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	459
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	460 if location == '':
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	461 # Use system mupdf.
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	462 return None, location
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	463
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	464 local_dir = None
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	465 if local_tgz:
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	466 assert os.path.isfile(local_tgz)
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	467 elif location.startswith( 'git:'):
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	468 location_git = location[4:]
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	469 local_dir = 'mupdf-git'
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	470
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	471 # Try to update existing checkout.
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	472 e = run(f'cd {local_dir} && git pull && git submodule update --init', check=False)
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	473 if e:
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	474 # No existing git checkout, so do a fresh clone.
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	475 _fs_remove(local_dir)
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	476 gitargs = location[4:]
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	477 run(f'git clone --recursive --depth 1 --shallow-submodules {gitargs} {local_dir}')
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	478
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	479 # Show sha of checkout.
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	480 run( f'cd {local_dir} && git show --pretty=oneline\|head -n 1', check=False)
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	481 if sha:
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	482 run( f'cd {local_dir} && git checkout {sha}')
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	483 elif '://' in location:
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	484 # Download .tgz.
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	485 local_tgz = os.path.basename( location)
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	486 suffix = '.tar.gz'
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	487 assert location.endswith(suffix), f'Unrecognised suffix in remote URL {location=}.'
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	488 name = local_tgz[:-len(suffix)]
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	489 log( f'Download {location=} {local_tgz=} {name=}')
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	490 if os.path.exists(local_tgz):
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	491 try:
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	492 tar_check(local_tgz, 'r:gz', prefix=f'{name}/')
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	493 except Exception as e:
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	494 log(f'Not using existing file {local_tgz} because invalid tar data: {e}')
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	495 _fs_remove( local_tgz)
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	496 if os.path.exists(local_tgz):
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	497 log(f'Not downloading from {location} because already present: {local_tgz!r}')
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	498 else:
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	499 log(f'Downloading from {location=} to {local_tgz=}.')
1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	500 urllib.request.urlretrieve( location, local_tgz + '-')

1

1d09e1dec1d9 ADD: PyMuPDF v1.26.4: the original sdist.