hooks: add hook for intake

[mo-dkrz]

Add hook for intake to ensure that package's data and binaries of the drivers plugin are collected.

[rokm]

In general, please avoid using collect_all - instead, you should use collect_submodules, collect_data_files and/or collect_dynamic_libs (plus copy_metadata) as required.

Do any of these plugins actually contain binaries and/or data files? The couple from the start of the list that I've looked at all seem to be pure-python packages without binaries and/or data.

[rokm]

Hmm, actually, it looks like intake discovers its plugins via intake.drivers entry points. Does your use-case still work if you simplify the hook into:

# hook-intake.py
from PyInstaller.utils.hooks import collect_entry_point
datas, hiddenimports = collect_entry_point('intake.drivers')

[mo-dkrz]

Hmm, actually, it looks like intake discovers its plugins via intake.drivers entry points. Does your use-case still work if you simplify the hook into:

# hook-intake.py
from PyInstaller.utils.hooks import collect_entry_point
datas, hiddenimports = collect_entry_point('intake.drivers')

it was completely to-the-point, yes it works perfectly on my use case and rationally speaking it has to work for other cases as well since as you correctly said intake discovers them through the driver entrypoint. This could simplify the hook a lot. I will commit the change req in a moment

[rokm]

Looks like the PR was not opened with "Allow changes from maintainers", so I cannot push my follow-up changes.

Therefore, can you apply the following changes yourself:

---

1. The copyright year in the hook should be 2025

---

2. The news fragment should be updated to better reflect the nature of the new hook:
   Add hook for ``intake`` to collect its plugins (registered via the ``intake.drivers`` entry-point).

---

3. Insert

from PyInstaller import isolated

at line 17 of the test file, and modify the tests:

@importorskip('intake')
def test_intake(pyi_builder):
    pyi_builder.test_source("""
        import intake

        print(f"intake version: {intake.__version__}")
        catalog = intake.Catalog()
    """)


@importorskip('intake')
def test_intake_plugins(pyi_builder, tmp_path):
    # Get the list of plugins in unfrozen python
    @isolated.decorate
    def _get_intake_plugins():
        import intake
        return sorted(list(intake.registry))

    plugins_unfrozen = _get_intake_plugins()
    print(f"Unfrozen plugins: {plugins_unfrozen}")

    # Obtain list of plugins in frozen application.
    output_file = tmp_path / "output.txt"

    pyi_builder.test_source("""
        import sys
        import intake

        with open(sys.argv[1], 'w') as fp:
            for plugin in intake.registry:
                print(f"{plugin}", file=fp)
    """, app_args=[str(output_file)])

    with open(output_file, "r") as fp:
        plugins_frozen = sorted(line.strip() for line in fp)
    print(f"Frozen plugins: {plugins_frozen}")

    assert plugins_frozen == plugins_unfrozen

---

4. Insert

          # Install additional intake plugins for test_intake_plugins
          pip show -qq intake && pip install --prefer-binary intake-xarray

at line 162 of .github/workflows/pr-test.ym.

[mo-dkrz]

done