Requires users to configure hidden imports when used in a PyInstaller project.

appdirs does not suffer from this issue because all the source code is in one file appdirs.py

For example with app.py:

from platformdirs import user_data_dir

print(user_data_dir("appname"))

building this and running it gives an error due to the conditional imports PyInstaller can’t detect.

> pyinstaller app.py
> .\dist\app\app.exe
Traceback (most recent call last):
  File "app.py", line 1, in <module>
  File "PyInstaller\loader\pyimod03_importers.py", line 546, in exec_module
  File "platformdirs\__init__.py", line 31, in <module>
  File "platformdirs\__init__.py", line 27, in _set_platform_dir_class
  File "importlib\__init__.py", line 127, in import_module
ModuleNotFoundError: No module named 'platformdirs.windows'
[1348] Failed to execute script 'app' due to unhandled exception!

Users can fix this themselves by configuring a hidden import.

> pyinstaller app.py --hidden-import platformdirs.windows
> .\dist\app\app.exe
C:\Users\<User>\AppData\Local\appname\appname

However it would be nice if platformdirs provided a hook specifying the hidden imports. PyInstaller provides a mechanism for doing this https://pyinstaller.readthedocs.io/en/stable/hooks.html#provide-hooks-with-package Especially since I imagine the hidden import would be different depending on the platform.

[jalaziz]

I went ahead and put up https://github.com/pyinstaller/pyinstaller-hooks-contrib/pull/312 just in case.

[YariKartoshe4ka]

I think it is a good suggestion, so it must be done. I wrote some TODO for discussion:

• Create directory with hooks and registry it in setup.cfg
• Add hook with hiddenimports, each platform has its own import Note: Pyinstaller does not support Android
• Write tests to check changes ?Compile test binary and execute it in CI?

I suppose i can get started after adding user_documents_dir