hook-pkg_resources.py 2.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051
  1. #-----------------------------------------------------------------------------
  2. # Copyright (c) 2005-2021, PyInstaller Development Team.
  3. #
  4. # Distributed under the terms of the GNU General Public License (version 2
  5. # or later) with exception for distributing the bootloader.
  6. #
  7. # The full license is in the file COPYING.txt, distributed with this software.
  8. #
  9. # SPDX-License-Identifier: (GPL-2.0-or-later WITH Bootloader-exception)
  10. #-----------------------------------------------------------------------------
  11. from PyInstaller.utils.hooks import collect_submodules, is_module_satisfies
  12. # pkg_resources keeps vendored modules in its _vendor subpackage, and does sys.meta_path based import magic to expose
  13. # them as pkg_resources.extern.*
  14. hiddenimports = collect_submodules('pkg_resources._vendor')
  15. # pkg_resources v45.0 dropped support for Python 2 and added this module printing a warning. We could save some bytes if
  16. # we would replace this by a fake module.
  17. hiddenimports.append('pkg_resources.py2_warn')
  18. excludedimports = ['__main__']
  19. # Some more hidden imports. See:
  20. # https://github.com/pyinstaller/pyinstaller-hooks-contrib/issues/15#issuecomment-663699288 `packaging` can either be
  21. # its own package, or embedded in `pkg_resources._vendor.packaging`, or both. Assume the worst and include both if
  22. # present.
  23. hiddenimports += collect_submodules('packaging')
  24. hiddenimports += ['pkg_resources.markers']
  25. # As of v60.7, setuptools vendored jaraco and has pkg_resources use it. Currently, the pkg_resources._vendor.jaraco
  26. # namespace package cannot be automatically scanned due to limited support for pure namespace packages in our hook
  27. # utilities.
  28. #
  29. # In setuptools 60.7.0, the vendored jaraco.text package included "Lorem Ipsum.txt" data file, which also has to be
  30. # collected. However, the presence of the data file (and the resulting directory hierarchy) confuses the importer's
  31. # redirection logic; instead of trying to work-around that, tell user to upgrade or downgrade their setuptools.
  32. if is_module_satisfies("setuptools == 60.7.0"):
  33. raise SystemExit(
  34. "ERROR: Setuptools 60.7.0 is incompatible with PyInstaller. "
  35. "Downgrade to an earlier version or upgrade to a later version."
  36. )
  37. # In setuptools 60.7.1, the "Lorem Ipsum.txt" data file was dropped from the vendored jaraco.text package, so we can
  38. # accommodate it with couple of hidden imports.
  39. elif is_module_satisfies("setuptools >= 60.7.1"):
  40. hiddenimports += [
  41. 'pkg_resources._vendor.jaraco.functools',
  42. 'pkg_resources._vendor.jaraco.context',
  43. 'pkg_resources._vendor.jaraco.text',
  44. ]