spec Deprecation warnings

[adityaraute]

As I was building a package, I noticed these Deprecation warnings

313794 INFO: Including run-time hook 'pyi_rth__tkinter.py' from 'C:\\Projects\\Pyannote\\pyannote\\Lib\\site-packages\\PyInstaller\\hooks\\rthooks'
343638 INFO: Looking for dynamic libraries
W0417 09:38:07.915000 8992 Lib\site-packages\torch\distributed\elastic\multiprocessing\redirects.py:29] NOTE: Redirects are currently not supported in Windows or MacOs.
C:\Projects\Pyannote\pyannote\Lib\site-packages\PyInstaller\building\build_main.py:227: DeprecationWarning: `torch.distributed._sharding_spec` will be deprecated, use `torch.distributed._shard.sharding_spec` instead
  __import__(package)
C:\Projects\Pyannote\pyannote\Lib\site-packages\PyInstaller\building\build_main.py:227: DeprecationWarning: `torch.distributed._sharded_tensor` will be deprecated, use `torch.distributed._shard.sharded_tensor` instead
  __import__(package)
C:\Projects\Pyannote\pyannote\Lib\site-packages\PyInstaller\building\build_main.py:227: DeprecationWarning: `torch.distributed._shard.checkpoint` will be deprecated, use `torch.distributed.checkpoint` instead
  __import__(package)
C:\Projects\Pyannote\pyannote\Lib\site-packages\pyannote\core\notebook.py:134: MatplotlibDeprecationWarning: The get_cmap function was deprecated in Matplotlib 3.7 and will be removed in 3.11. Use ``matplotlib.colormaps[name]`` or ``matplotlib.colormaps.get_cmap()`` or ``pyplot.get_cmap()`` instead.
  cm = get_cmap("Set1")

I understand this is not an issue with the program or the build per se, but unsure if this could be related to hooks. Not sure if this is worth raising an issue, so sharing it here.

[adityaraute]

When I run the program, this is what I get

PyInstaller\hooks\rthooks\pyi_rth_pkgres.py:37: DeprecationWarning: pkg_resources is deprecated as an API. See https://setuptools.pypa.io/en/latest/pkg_resources.html

[rokm]

I understand this is not an issue with the program or the build per se, but unsure if this could be related to hooks. Not sure if this is worth raising an issue, so sharing it here.

No, these warnings are because before we look for dynamic libraries, we import all packages that we are going to collect, to automatically detect library search path modifications that some packages do. And some of these imported packages are deprecated. If you know that they are not used, you could explicitly exclude them from the program, for example --exclude torch.distributed._sharding_spec. Then it will not be imported before library search either, and will not trigger deprecation warning.

But generally, these are not an issue and can be ignored. Perhaps we can suppress deprecation warnings before starting the imports on our side...

When I run the program, this is what I get

PyInstaller\hooks\rthooks\pyi_rth_pkgres.py:37: DeprecationWarning: pkg_resources is deprecated as an API. See https://setuptools.pypa.io/en/latest/pkg_resources.html

This one is because pkg_resources was collected into the program, and so we run the run-time hook for it (in case it is actually used by program or one of its dependencies). It could be that nothing actually uses pkg_resources and it was unnecessarily collected - if you are sure this is the case, you can exclude it, e.g., via --exclude pkg_resources. In the spec file, this would be equivalent to adding the package/module name to the excludes list that is passed to Analysis.

[adityaraute]

But generally, these are not an issue and can be ignored.

Sounds good!

if you are sure this is the case, you can exclude it

I am not entirely sure, so I'd let it remain.

[rokm]

if you are sure this is the case, you can exclude it

I am not entirely sure, so I'd let it remain.

If you open build/<name>/xref-<name>.html and look for pkg_resources entry, what packages/modules are listed under "Imported by"?

[adityaraute]

Here:

imported by: [ctranslate2](https://github.com/orgs/pyinstaller/discussions/9105#ctranslate2) •
 [onnxruntime.transformers.machine_info](https://github.com/orgs/pyinstaller/discussions/9105#onnxruntime.transformers.machine_info) •
 [packaging](https://github.com/orgs/pyinstaller/discussions/9105#packaging) •
 [pyi_rth_pkgres.py](https://github.com/orgs/pyinstaller/discussions/9105#pyi_rth_pkgres.py) •
 [pytz](https://github.com/orgs/pyinstaller/discussions/9105#pytz) •
 [setuptools.command.bdist_egg](https://github.com/orgs/pyinstaller/discussions/9105#setuptools.command.bdist_egg) •
 [setuptools.dist](https://github.com/orgs/pyinstaller/discussions/9105#setuptools.dist) •
 [setuptools.installer](https://github.com/orgs/pyinstaller/discussions/9105#setuptools.installer) •
 [setuptools.wheel](https://github.com/orgs/pyinstaller/discussions/9105#setuptools.wheel)

[bwoodsend]

If you put import sys; sys.modules["pkg_resources"] = None at the top of your code before any other imports then run it (just regular Python – no need to use PyInstaller), it'll raise an import error if pkg_resources is actually needed. If it doesn't, you know it's safe to exclude.

[adityaraute]

Makes sense. The benefit of excluding would be getting rid of the warning, and reducing the final folder size, I presume.