Building on macOS fails

[jayvdb]

I have brew package mupdf installed

❯ brew ls mupdf
/usr/local/Cellar/mupdf/1.18.0_1/bin/mudraw
/usr/local/Cellar/mupdf/1.18.0_1/bin/mupdf-gl
/usr/local/Cellar/mupdf/1.18.0_1/bin/muraster
/usr/local/Cellar/mupdf/1.18.0_1/bin/mutool
/usr/local/Cellar/mupdf/1.18.0_1/include/mupdf/ (67 files)
/usr/local/Cellar/mupdf/1.18.0_1/lib/ (2 files)
/usr/local/Cellar/mupdf/1.18.0_1/share/doc/ (41 files)
/usr/local/Cellar/mupdf/1.18.0_1/share/man/ (3 files)

 error: command 'swig' failed with exit status 1
  ----------------------------------------
  ERROR: Failed building wheel for PyMuPDF
  Running setup.py clean for PyMuPDF
Failed to build PyMuPDF
Installing collected packages: PyMuPDF
    Running setup.py install for PyMuPDF: started
    Running setup.py install for PyMuPDF: finished with status 'error'
    ERROR: Command errored out with exit status 1:
     command: /Users/john.vandenberg/python/PyMuPDF/.tox/py38/bin/python -u -c 'import sys, setuptools, tokenize; sys.argv[0] = '"'"'/private/var/folders/hz/tflgsmps1g95cdq5hdptdhc00000gp/T/pip-req-build-hgk8h4xg/setup.py'"'"'; __file__='"'"'/private/var/folders/hz/tflgsmps1g95cdq5hdptdhc00000gp/T/pip-req-build-hgk8h4xg/setup.py'"'"';f=getattr(tokenize, '"'"'open'"'"', open)(__file__);code=f.read().replace('"'"'\r\n'"'"', '"'"'\n'"'"');f.close();exec(compile(code, __file__, '"'"'exec'"'"'))' install --record /private/var/folders/hz/tflgsmps1g95cdq5hdptdhc00000gp/T/pip-record-x_dvb7o9/install-record.txt --single-version-externally-managed --compile --install-headers /Users/john.vandenberg/python/PyMuPDF/.tox/py38/include/site/python3.8/PyMuPDF
         cwd: /private/var/folders/hz/tflgsmps1g95cdq5hdptdhc00000gp/T/pip-req-build-hgk8h4xg/
    Complete output (25 lines):
    running install
    running build
    running build_py
    running build_ext
    building 'fitz._fitz' extension
    swigging fitz/fitz.i to fitz/fitz_wrap.c
    swig -python -o fitz/fitz_wrap.c fitz/fitz.i
    fitz/fitz.i:254: Error: Unable to find 'version.i'
    fitz/fitz.i:255: Error: Unable to find 'helper-defines.i'
    fitz/fitz.i:256: Error: Unable to find 'helper-geo-c.i'
    fitz/fitz.i:257: Error: Unable to find 'helper-other.i'
    fitz/fitz.i:258: Error: Unable to find 'helper-pixmap.i'
    fitz/fitz.i:259: Error: Unable to find 'helper-geo-py.i'
    fitz/fitz.i:260: Error: Unable to find 'helper-annot.i'
    fitz/fitz.i:261: Error: Unable to find 'helper-stext.i'
    fitz/fitz.i:262: Error: Unable to find 'helper-fields.i'
    fitz/fitz.i:263: Error: Unable to find 'helper-python.i'
    fitz/fitz.i:264: Error: Unable to find 'helper-portfolio.i'
    fitz/fitz.i:265: Error: Unable to find 'helper-select.i'
    fitz/fitz.i:266: Error: Unable to find 'helper-xobject.i'
    fitz/fitz.i:267: Error: Unable to find 'helper-pdfinfo.i'
    fitz/fitz.i:268: Error: Unable to find 'helper-convert.i'
    fitz/fitz.i:269: Error: Unable to find 'helper-trace.i'
    fitz/fitz.i:270: Error: Unable to find 'helper-fileobj.i'
    error: command 'swig' failed with exit status 1
    ----------------------------------------
ERROR: Command errored out with exit status 1: /Users/john.vandenberg/python/PyMuPDF/.tox/py38/bin/python -u -c 'import sys, setuptools, tokenize; sys.argv[0] = '"'"'/private/var/folders/hz/tflgsmps1g95cdq5hdptdhc00000gp/T/pip-req-build-hgk8h4xg/setup.py'"'"'; __file__='"'"'/private/var/folders/hz/tflgsmps1g95cdq5hdptdhc00000gp/T/pip-req-build-hgk8h4xg/setup.py'"'"';f=getattr(tokenize, '"'"'open'"'"', open)(__file__);code=f.read().replace('"'"'\r\n'"'"', '"'"'\n'"'"');f.close();exec(compile(code, __file__, '"'"'exec'"'"'))' install --record /private/var/folders/hz/tflgsmps1g95cdq5hdptdhc00000gp/T/pip-record-x_dvb7o9/install-record.txt --single-version-externally-managed --compile --install-headers /Users/john.vandenberg/python/PyMuPDF/.tox/py38/include/site/python3.8/PyMuPDF Check the logs for full command output.

[jayvdb]

Yet on the same machine, this works:

❯ pip3 install .
Processing /Users/john.vandenberg/python/PyMuPDF
Building wheels for collected packages: PyMuPDF
  Building wheel for PyMuPDF (setup.py) ... done
  Created wheel for PyMuPDF: filename=PyMuPDF-1.18.12-cp38-cp38-macosx_10_9_x86_64.whl size=27917730 sha256=4f17974856c48b111aa18f464e04c60fdaa7f3bcf313a1020ac58aa500b6698d
  Stored in directory: /private/var/folders/hz/tflgsmps1g95cdq5hdptdhc00000gp/T/pip-ephem-wheel-cache-hcdd1ouw/wheels/3c/04/e8/0c74d1e5b782881b8a9f2907f91f1e08c4cec232da7ad3ba62
Successfully built PyMuPDF
Installing collected packages: PyMuPDF
Successfully installed PyMuPDF-1.18.12

[JorjMcKie]

Hm, I am still under-equipped with information. And also have no Mac OSX.

But

1. pre-requisite is the correct MuPDF installation - including all its 3rd party dependencies
2. There are two alternatives to install PyMuPDF from sources after that:
   1. Use the sources from PyPI. They only require Python and MuPDF include and Lib libraries
   2. Use the Github repo. This additionally requires a compatible SWIG installation (v4.0x.), which generates fitz_wrap.c and fitz.py using the multiple *.i files of the repo. The Github repo does not contain fitz_wrap.c / fitz.py files. This goes back to multiple requests issued by Linux package maintainers, who argued that these files are indeed generated by the generation - therefore useless and even preventing a meaningful diff report.

So I guess I do not yet understand which of these aspect you are reporting here.

[jayvdb]

I am using the GitHub repo. My default is swig 3. That may be the problem. However I do also have brew package swig@4 installed and could be found and used.

$ brew ls swig@4
/usr/local/Cellar/swig/4.0.2/bin/ccache-swig
/usr/local/Cellar/swig/4.0.2/bin/swig
/usr/local/Cellar/swig/4.0.2/share/swig/ (716 files)

[JorjMcKie]

Independently from this, it is weird, that SWIG doesn't find its *.i files. I don't know what may be different on your Mac machine compared to the configurations used by the Linux package maintainers, who seem to use that build path successfully.
This whole generation option was implemented by one of them by the way.

The SWIG invocation command on my Windows machine is swig -python -py3 fitz\fitz.i.
The -py3 parameter is used since abandoning Python 2. It will cause SWIG to generate the new Python fast vector call for 3.8 and up.
SWIG's output (fitz_wrap.c and fitz.py) is generated into the fitz folder, from where setup.py picks them up together with utils.py and __init__.py