Review Request 126345: PythonMacros: specify destination directory in byte-compiled files

[Raphael Kubo da Costa]

-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://git.reviewboard.kde.org/r/126345/
-----------------------------------------------------------

Review request for Build System, kdelibs and Alex Merry.


Repository: kdelibs


Description
-------

The `PYTHON_INSTALL()` macro is a wrapper around the `py_compile` Python module that also installs the byte-code (.pyc) file it generates.

However, when a .py file is passed to `py_compile` without any additional arguments, its full path is recorded in the .pyc file. This is problematic, as most distributions install all files into a build root instead of simply copying files to `/` as part of the packaging process. In this case, the generated .pyc file will have something like
    /wrkdir/buildroot/usr/lib/python2.7/site-packages/Foo/my_module.py
in it. Not only does this show up in exception tracebacks, but if the user later invokes `my_module.py` and has write access to `my_module`'s directory, `my_module.pyc` will be rewritten with the right path to `my_module.py` (without the build root). This can lead to uninstallation errors if the package management system checks each file before removal, for example.

Fix it by rewritting the `PythonCompile.py` script so that it takes a `--destination-dir` argument that we use to pass the full path to `my_module.py` instead of letting it be (wrongly) deduced.


Diffs
-----

  cmake/modules/PythonCompile.py 156fea2 
  cmake/modules/PythonMacros.cmake 6a82d88 

Diff: https://git.reviewboard.kde.org/r/126345/diff/


Testing
-------

Fedora has packaging macros that will regenerate .pyc and .pyo files with the right paths as part of the build, so it is not affected. Debian disables this macro in pykde4, FreeBSD and openSUSE contain wrong paths in its .pyc files. With this patch, I was able to verify with `hexdump` that the right path is present in the .pyc files installed by pykde4.


Thanks,

Raphael Kubo da Costa

-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.kde.org/pipermail/kde-buildsystem/attachments/20151214/feea7ff2/attachment.html>