forked from pymupdf/PyMuPDF
-
Notifications
You must be signed in to change notification settings - Fork 0
/
setup.py
executable file
·1265 lines (1088 loc) · 44.9 KB
/
setup.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
#! /usr/bin/env python3
'''
Overview:
Build script for PyMuPDF, supporting PEP-517 and simple command-line usage.
We hard-code the URL of the MuPDF .tar.gz file that we require. This
generally points to a particular source release on mupdf.com.
Default behaviour:
Building an sdist:
As of 2024-002-28 we no longer download the MuPDF .tar.gz file and
embed it within the sdist. Instead it will be downloaded at build
time.
Building PyMuPDF:
We first download the hard-coded mupdf .tar.gz file.
Then we extract and build MuPDF locally, before building PyMuPDF
itself. So PyMuPDF will always be built with the exact MuPDF
release that we require.
Environmental variables:
If building with system MuPDF (PYMUPDF_SETUP_MUPDF_BUILD is empty string):
CFLAGS
CXXFLAGS
LDFLAGS
Added to c, c++, and link commands.
PYMUPDF_INCLUDES
Colon-separated extra include paths.
PYMUPDF_MUPDF_LIB
Directory containing MuPDF libraries, (libmupdf.so,
libmupdfcpp.so).
PYMUPDF_SETUP_IMPLEMENTATIONS
Must be one of 'a', 'b', 'ab'. If unset we use 'b'.
If contains 'a' we build obsolete classic implementation.
If contains 'b' we build rebased implementation.
PYMUPDF_SETUP_DEVENV
Location of devenv.com on Windows. If unset we search for it - see
wdev.py. if that fails we use just 'devenv.com'.
PYMUPDF_SETUP_FLAVOUR
Control building of separate wheels for PyMuPDF.
Must be unset or one of: 'pb', 'p', 'b'.
'pb' or unset:
Build complete wheel `PyMuPDF` with all Python and shared
libraries.
'p':
Wheel `PyMuPDF` excludes all shared libraries that are not
specific to a particular Python version - e.g. on Linux this
will exclude `libmupdf.so` and `libmupdfcpp.so`.
This wheel will require the corresponding PyMuPDFb wheel
- `PyMuPDF-<version>.dist-info/METADATA` will contain
`Requires-Dist: PyMuPDFb ==<version>`.
'b':
Build wheel called `PyMuPDFb` containing only shared libraries
that are not specific to a particular Python version - e.g.
on Linux this will be `libmupdf.so` and `libmupdfcpp.so`.
PYMUPDF_SETUP_LIBCLANG
For internal testing.
PYMUPDF_SETUP_MUPDF_BUILD
If set, overrides location of MuPDF when building PyMuPDF:
Empty string:
Build PyMuPDF with the system MuPDF.
A string starting with 'git:':
Use `git clone` to get a MuPDF checkout. We use the
string in the git clone command; it must contain the git
URL from which to clone, and can also contain other `git
clone` args, for example:
PYMUPDF_SETUP_MUPDF_BUILD="git:--branch master https://github.com/ArtifexSoftware/mupdf.git"
Otherwise:
Location of mupdf directory.
PYMUPDF_SETUP_MUPDF_BSYMBOLIC
If '0' we do not link libmupdf.so with -Bsymbolic.
PYMUPDF_SETUP_MUPDF_TESSERACT
If '0' we build MuPDF without Tesseract.
PYMUPDF_SETUP_MUPDF_BUILD_TYPE
Unix only. Controls build type of MuPDF. Supported values are:
debug
memento
release (default)
PYMUPDF_SETUP_MUPDF_CLEAN
Unix only. If '1', we do a clean MuPDF build.
PYMUPDF_SETUP_MUPDF_THIRD
If '0' and we are building on Linux with the system MuPDF
(i.e. PYMUPDF_SETUP_MUPDF_BUILD=''), then don't link with
`-lmupdf-third`.
PYMUPDF_SETUP_MUPDF_VS_UPGRADE
If '1' we run mupdf `scripts/mupdfwrap.py` with `--vs-upgrade 1` to
help Windows builds work with Visual Studio versions newer than 2019.
PYMUPDF_SETUP_MUPDF_TGZ
If set, overrides location of MuPDF .tar.gz file:
Empty string:
Do not download MuPDF .tar.gz file. Sdist's will not contain
MuPDF.
A string containing '://':
The URL from which to download the MuPDF .tar.gz file. Leaf
must match mupdf-*.tar.gz.
Otherwise:
The path of local mupdf git checkout. We put all files in this
checkout known to git into a local tar archive.
PYMUPDF_SETUP_MUPDF_OVERWRITE_CONFIG
If '0' we do not overwrite MuPDF's include/mupdf/fitz/config.h with
PyMuPDF's own configuration file, before building MuPDF.
PYMUPDF_SETUP_MUPDF_REBUILD
If 0 we do not (re)build mupdf.
PYMUPDF_SETUP_REBUILD_GIT_DETAILS
Classic implementation only. If '0' we do not rebuild if only
src_classic/helper-git-versions.i has changed.
WDEV_VS_YEAR
If set, we use as Visual Studio year, for example '2019' or '2022'.
WDEV_VS_GRADE
If set, we use as Visual Studio grade, for example 'Community' or
'Professional' or 'Enterprise'.
'''
import glob
import io
import os
import textwrap
import time
import platform
import re
import shlex
import shutil
import stat
import subprocess
import sys
import tarfile
import urllib.request
import zipfile
import pipcl
_log_prefix = None
def log( text):
global _log_prefix
if not _log_prefix:
# This typically sets _log_prefix to `PyMuPDF/setup.py`.
p = os.path.abspath( __file__)
p, p1 = os.path.split( p)
p, p0 = os.path.split( p)
_log_prefix = os.path.join( p0, p1)
print(f'{_log_prefix}: {text}', file=sys.stdout)
sys.stdout.flush()
if 1:
# For debugging.
log(f'### Starting.')
log(f'__name__: {__name__!r}')
log(f'platform.platform(): {platform.platform()!r}')
log(f'platform.python_version(): {platform.python_version()!r}')
log(f'sys.executable: {sys.executable!r}')
log(f'CPU bits: {32 if sys.maxsize == 2**31 - 1 else 64} {sys.maxsize=}')
log(f'__file__: {__file__!r}')
log(f'os.getcwd(): {os.getcwd()!r}')
log(f'sys.argv ({len(sys.argv)}):')
for i, arg in enumerate(sys.argv):
log(f' {i}: {arg!r}')
log(f'os.environ ({len(os.environ)}):')
for k in sorted( os.environ.keys()):
v = os.environ[ k]
log( f' {k}: {v!r}')
g_flavour = os.environ.get( 'PYMUPDF_SETUP_FLAVOUR', 'pb')
assert g_flavour in ('p', 'b', 'pb'), \
f'Unrecognised {g_flavour=} should be one of: "p", "b", "pb"'
g_root = os.path.abspath( f'{__file__}/..')
# Name of file that identifies that we are in a PyMuPDF sdist.
g_pymupdfb_sdist_marker = 'pymupdfb_sdist'
def _fs_remove(path):
'''
Removes file or directory, without raising exception if it doesn't exist.
We assert-fail if the path still exists when we return, in case of
permission problems etc.
'''
# First try deleting `path` as a file.
try:
os.remove( path)
except Exception as e:
pass
if os.path.exists(path):
# Try deleting `path` as a directory. Need to use
# shutil.rmtree() callback to handle permission problems; see:
# https://docs.python.org/3/library/shutil.html#rmtree-example
#
def error_fn(fn, path, excinfo):
# Clear the readonly bit and reattempt the removal.
os.chmod(path, stat.S_IWRITE)
fn(path)
shutil.rmtree( path, onerror=error_fn)
assert not os.path.exists( path)
def run(command, check=1):
log(f'Running: {command}')
return subprocess.run( command, shell=1, check=check)
def _git_get_branch( directory):
command = f'cd {directory} && git branch --show-current'
log( f'Running: {command}')
p = subprocess.run(
command,
shell=True,
check=False,
text=True,
stdout=subprocess.PIPE,
)
ret = None
if p.returncode == 0:
ret = p.stdout.strip()
log( f'Have found MuPDF git branch: ret={ret!r}')
return ret
def tar_check(path, mode='r:gz', prefix=None, remove=False):
'''
Checks items in tar file have same <top-directory>, or <prefix> if not None.
We fail if items in tar file have different top-level directory names.
path:
The tar file.
mode:
As tarfile.open().
prefix:
If not None, we fail if tar file's <top-directory> is not <prefix>.
Returns the directory name (which will be <prefix> if not None).
'''
with tarfile.open( path, mode) as t:
items = t.getnames()
assert items
item = items[0]
assert not item.startswith('./') and not item.startswith('../')
s = item.find('/')
if s == -1:
prefix_actual = item + '/'
else:
prefix_actual = item[:s+1]
if prefix:
assert prefix == prefix_actual, f'{path=} {prefix=} {prefix_actual=}'
for item in items[1:]:
assert item.startswith( prefix_actual), f'prefix_actual={prefix_actual!r} != item={item!r}'
return prefix_actual
def tar_extract(path, mode='r:gz', prefix=None, exists='raise'):
'''
Extracts tar file into single local directory.
We fail if items in tar file have different <top-directory>.
path:
The tar file.
mode:
As tarfile.open().
prefix:
If not None, we fail if tar file's <top-directory> is not <prefix>.
exists:
What to do if <top-directory> already exists:
'raise': raise exception.
'remove': remove existing file/directory before extracting.
'return': return without extracting.
Returns the directory name (which will be <prefix> if not None, with '/'
appended if not already present).
'''
prefix_actual = tar_check( path, mode, prefix)
if os.path.exists( prefix_actual):
if exists == 'raise':
raise Exception( f'Path already exists: {prefix_actual!r}')
elif exists == 'remove':
remove( prefix_actual)
elif exists == 'return':
log( f'Not extracting {path} because already exists: {prefix_actual}')
return prefix_actual
else:
assert 0, f'Unrecognised exists={exists!r}'
assert not os.path.exists( prefix_actual), f'Path already exists: {prefix_actual}'
log( f'Extracting {path}')
with tarfile.open( path, mode) as t:
t.extractall()
return prefix_actual
def get_git_id( directory):
'''
Returns `(sha, comment, diff, branch)`, all items are str or None if not
available.
directory:
Root of git checkout.
'''
sha, comment, diff, branch = '', '', '', ''
cp = subprocess.run(
f'cd {directory} && (PAGER= git show --pretty=oneline|head -n 1 && git diff)',
capture_output=1,
shell=1,
text=1,
)
if cp.returncode == 0:
sha, _ = cp.stdout.split(' ', 1)
comment, diff = _.split('\n', 1)
cp = subprocess.run(
f'cd {directory} && git rev-parse --abbrev-ref HEAD',
capture_output=1,
shell=1,
text=1,
)
if cp.returncode == 0:
branch = cp.stdout.strip()
log(f'get_git_id(): directory={directory!r} returning branch={branch!r} sha={sha!r} comment={comment!r}')
return sha, comment, diff, branch
mupdf_tgz = os.path.abspath( f'{__file__}/../mupdf.tgz')
def get_mupdf_internal(out, location=None, sha=None, local_tgz=None):
'''
Gets MuPDF as either a .tgz or a local directory.
Args:
out:
Either 'dir' (we return name of local directory containing mupdf) or 'tgz' (we return
name of local .tgz file containing mupdf).
location:
First, if None we set to hard-coded default URL or git location.
If starts with 'git:', should be remote git location.
Otherwise if containg '://' should be URL for .tgz.
Otherwise shuld path of local mupdf checkout.
sha:
If not None and we use git clone, we checkout this sha.
local_tgz:
If not None, must be local .tgz file.
Returns:
Absolute path of local directory or .tgz containing MuPDF, or None if
we are to use system MuPDF.
'''
log(f'get_mupdf_internal(): {out=} {location=} {sha=}')
assert out in ('dir', 'tgz')
if location is None:
location = 'https://mupdf.com/downloads/archive/mupdf-1.24.2-source.tar.gz'
#location = 'git:--branch master https://github.com/ArtifexSoftware/mupdf.git'
if location == '':
# Use system mupdf.
return
local_dir = None
if local_tgz:
assert os.path.isfile(local_tgz)
elif location.startswith( 'git:'):
location_git = location[4:]
local_dir = 'mupdf-git'
# Try to update existing checkout.
e = run(f'cd {local_dir} && git pull && git submodule update --init', check=False).returncode
if e:
# No existing git checkout, so do a fresh clone.
_fs_remove(local_dir)
run(f'git clone --recursive --depth 1 --shallow-submodules {location[4:]} {local_dir}')
# Show sha of checkout.
run( f'cd {local_dir} && git show --pretty=oneline|head -n 1', check=False)
if sha:
command = f'cd mupdf && git checkout {sha}'
log( f'Running: {command}')
run( f'cd mupdf && git checkout {sha}')
elif '://' in location:
# Download .tgz.
local_tgz = os.path.basename( location)
suffix = '.tar.gz'
assert location.endswith(suffix), f'Unrecognised suffix in remote URL {location=}.'
name = local_tgz[:-len(suffix)]
log( f'Download {location=} {local_tgz=} {name=}')
if os.path.exists(local_tgz):
try:
tar_check(local_tgz, 'r:gz', prefix=f'{name}/')
except Exception as e:
log(f'Not using existing file {local_tgz} because invalid tar data: {e}')
_fs_remove( local_tgz)
if os.path.exists(local_tgz):
log(f'Not downloading from {location} because already present: {local_tgz!r}')
else:
log(f'Downloading from {location=} to {local_tgz=}.')
urllib.request.urlretrieve( location, local_tgz)
assert os.path.exists( local_tgz)
tar_check( local_tgz, 'r:gz', prefix=f'{name}/')
else:
assert os.path.isdir(location), f'Local MuPDF does not exist: {location=}'
local_dir = location
assert bool(local_dir) != bool(local_tgz)
if out == 'dir':
if not local_dir:
assert local_tgz
local_dir = tar_extract( local_tgz, exists='return')
return os.path.abspath( local_dir)
elif out == 'tgz':
if not local_tgz:
# Create .tgz containing git files in `local_dir`.
assert local_dir
if local_dir.endswith( '/'):
local_dir = local_dir[:-1]
top = os.path.basename(local_dir)
local_tgz = f'{local_dir}.tgz'
log( f'Creating .tgz from git files. {top=} {local_dir=} {local_tgz=}')
_fs_remove( local_tgz)
with tarfile.open( local_tgz, 'w:gz') as f:
for name in pipcl.git_items( local_dir, submodules=True):
path = os.path.join( local_dir, name)
if os.path.isfile( path):
path2 = f'{top}/{name}'
log(f'Adding {path=} {path2=}.')
f.add( path, path2, recursive=False)
return os.path.abspath( local_tgz)
else:
assert 0, f'Unrecognised {out=}'
def get_mupdf_tgz():
'''
Creates .tgz file called containing MuPDF source, for inclusion in an
sdist.
What we do depends on environmental variable PYMUPDF_SETUP_MUPDF_TGZ; see
docs at start of this file for details.
Returns name of top-level directory within the .tgz file.
'''
name = get_mupdf_internal( 'tgz', os.environ.get('PYMUPDF_SETUP_MUPDF_TGZ'))
return name
def get_mupdf(path=None, sha=None):
'''
Downloads and/or extracts mupdf and returns location of mupdf directory.
Exact behaviour depends on environmental variable
PYMUPDF_SETUP_MUPDF_BUILD; see docs at start of this file for details.
'''
m = os.environ.get('PYMUPDF_SETUP_MUPDF_BUILD')
if m is None and os.path.isfile(mupdf_tgz):
# This makes us use tgz inside sdist.
log(f'Using local tgz: {mupdf_tgz=}')
return get_mupdf_internal('dir', local_tgz=mupdf_tgz)
return get_mupdf_internal('dir', m)
linux = sys.platform.startswith( 'linux') or 'gnu' in sys.platform
openbsd = sys.platform.startswith( 'openbsd')
freebsd = sys.platform.startswith( 'freebsd')
darwin = sys.platform.startswith( 'darwin')
windows = platform.system() == 'Windows' or platform.system().startswith('CYGWIN')
msys2 = platform.system().startswith('MSYS_NT-')
pyodide = os.environ.get('OS') == 'pyodide'
def _implementations():
v = os.environ.get( 'PYMUPDF_SETUP_IMPLEMENTATIONS', 'b')
assert v in ('a', 'b', 'ab')
return v
def build():
'''
pipcl.py `build_fn()` callback.
'''
# Download MuPDF.
#
mupdf_local = get_mupdf()
build_type = os.environ.get( 'PYMUPDF_SETUP_MUPDF_BUILD_TYPE', 'release')
assert build_type in ('debug', 'memento', 'release'), \
f'Unrecognised build_type={build_type!r}'
# Copy our config header on top of MuPDF's config.h.
#
env_extra = dict()
if mupdf_local:
if windows:
from_ = f'{g_root}/src_classic/_config.h'
to_ = f'{mupdf_local}/include/mupdf/fitz/config.h'
if os.environ.get('PYMUPDF_SETUP_MUPDF_OVERWRITE_CONFIG') == '0':
# Use MuPDF default config.
if windows:
log( f'Not copying {from_} to {to_}.')
else:
log( f'Not predefining TOFU_CJK_EXT.')
else:
# Our config differs from MuPDF's default in that it defines TOFU_CJK_EXT
# This tells the MuPDF shared-library build to exclude large unused font
# files such as resources/fonts/han/SourceHanSerif-Regular.ttc.
#
if windows:
# No equivalent to XCFLAGS. We could create an override.props
# file and run devenv.com with
# `-p:ForceImportBeforeCppTargets=$(SolutionDir)override.props`,
# but for now we just overwrite MuPDF's config.h.
log( f'Copying {from_} to {to_}.')
shutil.copy2( from_, to_)
s = os.stat( f'{to_}')
log( f'{to_}: {s} mtime={time.strftime("%F-%T", time.gmtime(s.st_mtime))}')
else:
# By predefining TOFU_CJK_EXT here, we don't need to modify
# MuPDF's include/mupdf/fitz/config.h.
log( f'Setting XCFLAGS and XCXXFLAGS to predefine TOFU_CJK_EXT.')
env_add(env_extra, 'XCFLAGS', '-DTOFU_CJK_EXT')
env_add(env_extra, 'XCXXFLAGS', '-DTOFU_CJK_EXT')
# Build MuPDF shared libraries.
#
if windows:
mupdf_build_dir = build_mupdf_windows( mupdf_local, env_extra, build_type)
else:
mupdf_build_dir = build_mupdf_unix( mupdf_local, env_extra, build_type)
log( f'build(): mupdf_build_dir={mupdf_build_dir!r}')
# Build rebased `extra` module (and/or PyMuPDF classic if specified).
#
path_so_leaf_a, path_so_leaf_b = _build_extensions(
mupdf_local,
mupdf_build_dir,
build_type,
)
# Generate lists of (from, to) items to return to pipcl. We put MuPDF
# shared libraries in a separate list so that we can build specific wheels
# as determined by g_flavour.
#
ret_p = list() # For PyMuPDF.
ret_b = list() # For PyMuPDFb.
def add( ret, from_, to_):
ret.append( (from_, to_))
if path_so_leaf_a:
# Add classic implementation files.
to_dir = 'fitz_old/'
add( ret_p, f'{g_root}/src_classic/__init__.py', to_dir)
add( ret_p, f'{g_root}/src_classic/__main__.py', to_dir)
add( ret_p, f'{g_root}/src_classic/fitz_old.py', to_dir)
add( ret_p, f'{g_root}/src/table.py', to_dir)
add( ret_p, f'{g_root}/src_classic/utils.py', to_dir)
add( ret_p, f'{g_root}/src_classic/{path_so_leaf_a}', to_dir)
if mupdf_local:
# Add mupdf shared library next to `path_so_leaf_a` so it will be
# found at runtime. Would prefer to embed a softlink to mupdfpy's
# file but wheels do not seem to support them.
if windows:
wp = pipcl.wdev.WindowsPython()
add( ret_b, f'{mupdf_build_dir}/mupdfcpp{wp.cpu.windows_suffix}.dll', to_dir)
elif darwin:
add( ret_b, f'{mupdf_build_dir}/libmupdf.dylib', f'{to_dir}libmupdf.dylib')
elif pyodide:
add( ret_b, f'{mupdf_build_dir}/libmupdf.so', 'PyMuPDF.libs/')
else:
add( ret_b, pipcl.get_soname(f'{mupdf_build_dir}/libmupdf.so'), to_dir)
if path_so_leaf_b:
# Add rebased implementation files.
to_dir = 'pymupdf/'
add( ret_p, f'{g_root}/src/__init__.py', to_dir)
add( ret_p, f'{g_root}/src/__main__.py', to_dir)
add( ret_p, f'{g_root}/src/pymupdf.py', to_dir)
add( ret_p, f'{g_root}/src/table.py', to_dir)
add( ret_p, f'{g_root}/src/utils.py', to_dir)
add( ret_p, f'{g_root}/src/_apply_pages.py', to_dir)
add( ret_p, f'{g_root}/src/build/extra.py', to_dir)
add( ret_p, f'{g_root}/src/build/{path_so_leaf_b}', to_dir)
# Add support for `fitz` backwards compatibility.
add( ret_p, f'{g_root}/src/fitz___init__.py', 'fitz/__init__.py')
add( ret_p, f'{g_root}/src/fitz_table.py', 'fitz/table.py')
add( ret_p, f'{g_root}/src/fitz_utils.py', 'fitz/utils.py')
if mupdf_local:
# Add MuPDF Python API.
add( ret_p, f'{mupdf_build_dir}/mupdf.py', to_dir)
# Add MuPDF shared libraries.
if windows:
wp = pipcl.wdev.WindowsPython()
add( ret_p, f'{mupdf_build_dir}/_mupdf.pyd', to_dir)
add( ret_b, f'{mupdf_build_dir}/mupdfcpp{wp.cpu.windows_suffix}.dll', to_dir)
elif darwin:
add( ret_p, f'{mupdf_build_dir}/_mupdf.so', to_dir)
add( ret_b, f'{mupdf_build_dir}/libmupdfcpp.so', to_dir)
add( ret_b, f'{mupdf_build_dir}/libmupdf.dylib', f'{to_dir}libmupdf.dylib')
elif pyodide:
add( ret_p, f'{mupdf_build_dir}/_mupdf.so', to_dir)
add( ret_b, f'{mupdf_build_dir}/libmupdfcpp.so', 'PyMuPDF.libs/')
add( ret_b, f'{mupdf_build_dir}/libmupdf.so', 'PyMuPDF.libs/')
else:
add( ret_p, f'{mupdf_build_dir}/_mupdf.so', to_dir)
add( ret_b, pipcl.get_soname(f'{mupdf_build_dir}/libmupdfcpp.so'), to_dir)
add( ret_b, pipcl.get_soname(f'{mupdf_build_dir}/libmupdf.so'), to_dir)
if g_flavour == 'pb':
ret = ret_p + ret_b
elif g_flavour == 'p':
ret = ret_p
elif g_flavour == 'b':
ret = ret_b
else:
assert 0
if g_flavour == 'b':
add( ret, f'{g_root}/READMErb.md', '$dist-info/README.md')
else:
add( ret, f'{g_root}/README.md', '$dist-info/README.md')
return ret
def env_add(env, name, value, sep=' ', prepend=False, verbose=False):
'''
Appends/prepends `<value>` to `env[name]`.
If `name` is not in `env`, we use os.environ[nane] if it exists.
'''
v = env.get(name)
if verbose:
log(f'Initally: {name}={v!r}')
if v is None:
v = os.environ.get(name)
if v is None:
env[ name] = value
else:
if prepend:
env[ name] = f'{value}{sep}{v}'
else:
env[ name] = f'{v}{sep}{value}'
if verbose:
log(f'Returning with {name}={env[name]!r}')
def build_mupdf_windows( mupdf_local, env, build_type):
assert mupdf_local
wp = pipcl.wdev.WindowsPython()
tesseract = '' if os.environ.get('PYMUPDF_SETUP_MUPDF_TESSERACT') == '0' else 'tesseract-'
windows_build_tail = f'build\\shared-{tesseract}{build_type}-x{wp.cpu.bits}-py{wp.version}'
windows_build_dir = f'{mupdf_local}\\{windows_build_tail}'
#log( f'Building mupdf.')
devenv = os.environ.get('PYMUPDF_SETUP_DEVENV')
if not devenv:
vs = pipcl.wdev.WindowsVS()
devenv = vs.devenv
if not devenv:
devenv = 'devenv.com'
log( f'Cannot find devenv.com in default locations, using: {devenv!r}')
command = f'cd "{mupdf_local}" && "{sys.executable}" ./scripts/mupdfwrap.py'
if os.environ.get('PYMUPDF_SETUP_MUPDF_VS_UPGRADE') == '1':
command += ' --vs-upgrade 1'
# Would like to simply do f'... --devenv {shutil.quote(devenv)}', but
# it looks like if `devenv` has spaces then `shutil.quote()` puts it
# inside single quotes, which then appear to be ignored when run by
# subprocess.run().
#
# So instead we strip any enclosing quotes and the enclose with
# double-quotes.
#
if len(devenv) >= 2:
for q in '"', "'":
if devenv.startswith( q) and devenv.endswith( q):
devenv = devenv[1:-1]
command += f' -d {windows_build_tail} -b --refcheck-if "#if 1" --devenv "{devenv}" '
if 'b' in _implementations():
command += 'all'
else:
command += '01' # No need for C++/Python bindings.
env2 = os.environ.copy()
env2.update(env)
if os.environ.get( 'PYMUPDF_SETUP_MUPDF_REBUILD') == '0':
log( f'PYMUPDF_SETUP_MUPDF_REBUILD is "0" so not building MuPDF; would have run with env={env!r}: {command}')
else:
log( f'Building MuPDF by running with {env=}: {command}')
subprocess.run( command, shell=True, check=True, env=env2)
log( f'Finished building mupdf.')
return windows_build_dir
def build_mupdf_unix( mupdf_local, env, build_type):
'''
Builds MuPDF.
Args:
mupdf_local:
Path of MuPDF directory or None if we are using system MuPDF.
Returns the absolute path of build directory within MuPDF, e.g.
`.../mupdf/build/pymupdf-shared-release`, or `None` if we are using the
system MuPDF.
'''
if not mupdf_local:
log( f'Using system mupdf.')
return None
env = env.copy()
if openbsd or freebsd:
env_add(env, 'CXX', 'c++', ' ')
# Add extra flags for MacOS cross-compilation, where ARCHFLAGS can be
# '-arch arm64'.
#
archflags = os.environ.get( 'ARCHFLAGS')
if archflags:
env_add(env, 'XCFLAGS', archflags)
env_add(env, 'XLIBS', archflags)
# We specify a build directory path containing 'pymupdf' so that we
# coexist with non-PyMuPDF builds (because PyMuPDF builds have a
# different config.h).
#
# We also append further text to try to allow different builds to
# work if they reuse the mupdf directory.
#
# Using platform.machine() (e.g. 'amd64') ensures that different
# builds of mupdf on a shared filesystem can coexist. Using
# $_PYTHON_HOST_PLATFORM allows cross-compiled cibuildwheel builds
# to coexist, e.g. on github.
#
build_prefix = f'PyMuPDF-'
if pyodide:
build_prefix += 'pyodide-'
else:
build_prefix += f'{platform.machine()}-'
build_prefix_extra = os.environ.get( '_PYTHON_HOST_PLATFORM')
if build_prefix_extra:
build_prefix += f'{build_prefix_extra}-'
build_prefix += 'shared-'
if msys2:
# Error in mupdf/scripts/tesseract/endianness.h:
# #error "I don't know what architecture this is!"
log(f'msys2: building MuPDF without tesseract.')
elif os.environ.get('PYMUPDF_SETUP_MUPDF_TESSERACT') == '0':
log(f'PYMUPDF_SETUP_MUPDF_TESSERACT=0 so building mupdf without tesseract.')
else:
build_prefix += 'tesseract-'
mupdf_version_tuple = get_mupdf_version(mupdf_local)
if (
linux
and os.environ.get('PYMUPDF_SETUP_MUPDF_BSYMBOLIC', '1') == '1'
and mupdf_version_tuple >= (1, 24, 3)
):
log(f'Appending `bsymbolic-` to MuPDF build path.')
build_prefix += 'bsymbolic-'
unix_build_dir = f'{mupdf_local}/build/{build_prefix}{build_type}'
# We need MuPDF's Python bindings, so we build MuPDF with
# `mupdf/scripts/mupdfwrap.py` instead of running `make`.
#
env_string = ''
for n, v in env.items():
env_string += f' {n}={shlex.quote(v)}'
command = f'cd {mupdf_local} &&{env_string} {sys.executable} ./scripts/mupdfwrap.py -d build/{build_prefix}{build_type} -b '
if 'b' in _implementations() and 'p' in g_flavour:
command += 'all'
else:
command += 'm01' # No need for C++/Python bindings.
command += f' && echo {unix_build_dir}:'
command += f' && ls -l {unix_build_dir}'
if os.environ.get( 'PYMUPDF_SETUP_MUPDF_REBUILD') == '0':
log( f'PYMUPDF_SETUP_MUPDF_REBUILD is "0" so not building MuPDF; would have run: {command}')
else:
log( f'Building MuPDF by running: {command}')
subprocess.run( command, shell=True, check=True)
log( f'Finished building mupdf.')
return unix_build_dir
def get_mupdf_version(mupdf_dir):
path = f'{mupdf_dir}/include/mupdf/fitz/version.h'
with open(path) as f:
text = f.read()
v0 = re.search('#define FZ_VERSION_MAJOR ([0-9]+)', text)
v1 = re.search('#define FZ_VERSION_MINOR ([0-9]+)', text)
v2 = re.search('#define FZ_VERSION_PATCH ([0-9]+)', text)
assert v0 and v1 and v2, f'Cannot find MuPDF version numers in {path=}.'
v0 = int(v0.group(1))
v1 = int(v1.group(1))
v2 = int(v2.group(1))
return v0, v1, v2
def _fs_update(text, path):
try:
with open( path) as f:
text0 = f.read()
except OSError:
text0 = None
print(f'path={path!r} text==text0={text==text0!r}')
if text != text0:
with open( path, 'w') as f:
f.write( text)
def _build_extensions( mupdf_local, mupdf_build_dir, build_type):
'''
Builds Python extension modules `_pymupdf` and `_extra`.
Returns (path_so_leaf_a, path_so_leaf_b), the leafnames of the generated
shared libraries within mupdf_build_dir.
'''
path_so_leaf_a = None
path_so_leaf_b = None
if 'a' in _implementations():
path_so_leaf_a = _build_extension_classic( mupdf_local, mupdf_build_dir, build_type)
if 'b' in _implementations():
path_so_leaf_b = _build_extension_rebased( mupdf_local, mupdf_build_dir, build_type)
return path_so_leaf_a, path_so_leaf_b
def _build_extension_classic( mupdf_local, mupdf_build_dir, build_type):
'''
Builds Python extension module `_fitz` for obsolete classic implementation.
Returns leafname of the generated shared libraries within mupdf_build_dir.
'''
(compiler_extra, linker_extra, includes, defines, optimise, debug, libpaths, libs, libraries) \
= _extension_flags( mupdf_local, mupdf_build_dir, build_type)
# Update helper-git-versions.i.
f = io.StringIO()
f.write('%pythoncode %{\n')
def repr_escape(text):
text = repr(text)
text = text.replace('{', '{{')
text = text.replace('}', '}}')
text = text.replace('%', '{chr(37)})') # Avoid confusing swig.
return 'f' + text
def write_git(name, directory):
sha, comment, diff, branch = get_git_id(directory)
f.write(f'{name}_git_sha = \'{sha}\'\n')
f.write(f'{name}_git_comment = {repr_escape(comment)}\n')
f.write(f'{name}_git_diff = {repr_escape(diff)}\n')
f.write(f'{name}_git_branch = {repr_escape(branch)}\n')
f.write('\n')
write_git('pymupdf', '.')
if mupdf_local:
write_git('mupdf', mupdf_local)
f.write('%}\n')
_fs_update( f.getvalue(), 'src_classic/helper-git-versions.i')
if os.environ.get( 'PYMUPDF_SETUP_REBUILD_GIT_DETAILS') == '0':
log( f'Marking src_classic/helper-git-versions.i as old because PYMUPDF_SETUP_REBUILD_GIT_DETAILS=0')
os.utime( 'src_classic/helper-git-versions.i', (1, 1))
if windows:
compiler_extra_c = ''
else:
compiler_extra_c = (
' -Wno-incompatible-pointer-types'
' -Wno-pointer-sign'
' -Wno-sign-compare'
)
prerequisites_swig = glob.glob( f'{g_root}/src_classic/*.i')
if os.environ.get( 'PYMUPDF_SETUP_REBUILD_GIT_DETAILS') == '0':
# Remove helper-git-versions.i from prerequisites_swig so
# it doesn't force rebuild on its own. [Cannot easily use
# prerequisites_swig.remove() because / vs \ on Windows.]
#
for i, p in enumerate( prerequisites_swig):
if p.endswith( 'helper-git-versions.i'):
del prerequisites_swig[i]
break
else:
assert 0, f'Cannot find *helper-git-versions.i in prerequisites_swig: {prerequisites_swig}'
path_so_leaf_a = pipcl.build_extension(
name = 'fitz_old',
path_i = f'{g_root}/src_classic/fitz_old.i',
outdir = f'{g_root}/src_classic',
includes = includes,
defines = defines,
libpaths = libpaths,
libs = libs,
compiler_extra = compiler_extra + compiler_extra_c,
linker_extra = linker_extra,
optimise = optimise,
debug = debug,
cpp = False,
prerequisites_swig = prerequisites_swig,
prerequisites_compile = f'{mupdf_local}/include',
prerequisites_link = libraries,
)
return path_so_leaf_a
def _build_extension_rebased( mupdf_local, mupdf_build_dir, build_type):
'''
Builds Python extension module `_extra` for rebased implementation.
Returns leafname of the generated shared libraries within mupdf_build_dir.
'''
(compiler_extra, linker_extra, includes, defines, optimise, debug, libpaths, libs, libraries) \
= _extension_flags( mupdf_local, mupdf_build_dir, build_type)
if mupdf_local:
includes = (
f'{mupdf_local}/platform/c++/include',
f'{mupdf_local}/include',
)
# Build rebased extension module.
log('Building PyMuPDF rebased.')
compile_extra_cpp = ''
if darwin:
# Avoids `error: cannot pass object of non-POD type
# 'std::nullptr_t' through variadic function; call will abort at
# runtime` when compiling `mupdf::pdf_dict_getl(..., nullptr)`.
compile_extra_cpp += ' -Wno-non-pod-varargs'
# Avoid errors caused by mupdf's C++ bindings' exception classes
# not having `nothrow` to match the base exception class.
compile_extra_cpp += ' -std=c++14'
if windows:
wp = pipcl.wdev.WindowsPython()
libs = f'mupdfcpp{wp.cpu.windows_suffix}.lib'
else:
libs = ('mupdf', 'mupdfcpp')
libraries = [
f'{mupdf_build_dir}/libmupdf.so'
f'{mupdf_build_dir}/libmupdfcpp.so'
]
path_so_leaf_b = pipcl.build_extension(
name = 'extra',
path_i = f'{g_root}/src/extra.i',
outdir = f'{g_root}/src/build',
includes = includes,
defines = defines,
libpaths = libpaths,
libs = libs,
compiler_extra = compiler_extra + compile_extra_cpp,
linker_extra = linker_extra,
optimise = optimise,
debug = debug,
prerequisites_swig = None,
prerequisites_compile = f'{mupdf_local}/include',
prerequisites_link = libraries,
)
return path_so_leaf_b
def _extension_flags( mupdf_local, mupdf_build_dir, build_type):
'''
Returns various flags to pass to pipcl.build_extension().
'''
compiler_extra = ''
linker_extra = ''
if build_type == 'memento':