File: hook-pkg_resources.py

package info (click to toggle)
pyinstaller 6.13.0%2Bds-2
  • links: PTS, VCS
  • area: main
  • in suites: trixie
  • size: 11,520 kB
  • sloc: python: 41,347; ansic: 11,334; makefile: 176; sh: 136; xml: 19
file content (68 lines) | stat: -rw-r--r-- 3,563 bytes parent folder | download | duplicates (3)
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
#-----------------------------------------------------------------------------
# Copyright (c) 2005-2023, PyInstaller Development Team.
#
# Distributed under the terms of the GNU General Public License (version 2
# or later) with exception for distributing the bootloader.
#
# The full license is in the file COPYING.txt, distributed with this software.
#
# SPDX-License-Identifier: (GPL-2.0-or-later WITH Bootloader-exception)
#-----------------------------------------------------------------------------

from PyInstaller.utils.hooks import collect_submodules, can_import_module
from PyInstaller.utils.hooks.setuptools import setuptools_info

hiddenimports = []
excludedimports = ['__main__']

# pkg_resources keeps vendored modules in its _vendor subpackage, and does sys.meta_path based import magic to expose
# them as pkg_resources.extern.*
#
# With setuptools >= 71.0, pkg_resources ceased to vendor packages, because vendoring is now done at the setuptools
# level.
if setuptools_info.available and setuptools_info.version < (71, 0, 0):
    # The `railroad` package is an optional requirement for `pyparsing`. `pyparsing.diagrams` depends on `railroad`, so
    # filter it out when `railroad` is not available.
    if can_import_module('railroad'):
        hiddenimports += collect_submodules('pkg_resources._vendor')
    else:
        hiddenimports += collect_submodules(
            'pkg_resources._vendor', filter=lambda name: 'pkg_resources._vendor.pyparsing.diagram' not in name
        )

    # pkg_resources v45.0 dropped support for Python 2 and added this module printing a warning. We could save some
    # bytes if we would replace this by a fake module.
    if setuptools_info.version >= (45, 0, 0) and setuptools_info.version < (49, 1, 1):
        hiddenimports += ['pkg_resources.py2_warn']

    # As of v60.7, setuptools vendored jaraco and has pkg_resources use it. Currently, the pkg_resources._vendor.jaraco
    # namespace package cannot be automatically scanned due to limited support for pure namespace packages in our hook
    # utilities.
    #
    # In setuptools 60.7.0, the vendored jaraco.text package included "Lorem Ipsum.txt" data file, which also has to be
    # collected. However, the presence of the data file (and the resulting directory hierarchy) confuses the importer's
    # redirection logic; instead of trying to work-around that, tell user to upgrade or downgrade their setuptools.
    if setuptools_info.version == (60, 7, 0):
        raise SystemExit(
            "ERROR: Setuptools 60.7.0 is incompatible with PyInstaller. "
            "Downgrade to an earlier version or upgrade to a later version."
        )
    # In setuptools 60.7.1, the "Lorem Ipsum.txt" data file was dropped from the vendored jaraco.text package, so we can
    # accommodate it with couple of hidden imports.
    elif setuptools_info.version >= (60, 7, 1):
        hiddenimports += [
            'pkg_resources._vendor.jaraco.functools',
            'pkg_resources._vendor.jaraco.context',
            'pkg_resources._vendor.jaraco.text',
        ]

    # As of setuptools 70.0.0, we need pkg_resources.extern added to hidden imports.
    if setuptools_info.version >= (70, 0, 0):
        hiddenimports += [
            'pkg_resources.extern',
        ]

# Some more hidden imports. See:
# https://github.com/pyinstaller/pyinstaller-hooks-contrib/issues/15#issuecomment-663699288 `packaging` can either be
# its own package, or embedded in `pkg_resources._vendor.packaging`, or both.
hiddenimports += collect_submodules('packaging')