gguf-py : avoid requiring PySide6 for packaged scripts

[compilade]

I'm using Nix devShells for my development, most often with nix develop .#default-extra.

Problem

I wanted to use gguf-dump with some model using the wrapper which that devShell puts in the $PATH, and was greeted with

$ gguf-dump --help
Traceback (most recent call last):
  File "/nix/store/l06dc60pbanrbm5ksvf0wh3n2q9blw4z-python3.12-gguf-0.0.0/bin/.gguf-dump-wrapped", line 6, in <module>
    from gguf.scripts import gguf_dump_entrypoint
  File "/nix/store/l06dc60pbanrbm5ksvf0wh3n2q9blw4z-python3.12-gguf-0.0.0/lib/python3.12/site-packages/gguf/scripts/__init__.py", line 9, in <module>
    from .gguf_editor_gui import main as gguf_editor_gui_entrypoint
  File "/nix/store/l06dc60pbanrbm5ksvf0wh3n2q9blw4z-python3.12-gguf-0.0.0/lib/python3.12/site-packages/gguf/scripts/gguf_editor_gui.py", line 15, in <module>
    from PySide6.QtWidgets import (
ModuleNotFoundError: No module named 'PySide6'

That should not be a fatal error, since gguf-dump doesn't require that module.

This is a problem likely introduced in #12930.

Note that this problem also happens when using pip install gguf in a venv.

Changes

• Remove gguf-py/gguf/scripts/__init__.py and directly refer to the main functions of the scripts as their entrypoint in pyproject.toml (as suggested in gguf-py : avoid requiring PySide6 for packaged scripts #13036 (comment))
  • __init__.py can be safely removed from that directory since https://peps.python.org/pep-0420/ (Python 3.3). (and it's not really imported anywhere anymore anyway)
• Add pyside6 to the python dependencies included in *-extra devShells
  • Its transitive dependencies are quite big, though (300 MB compressed). Hopefully that is fine with others who use the *-extra devShells
• Update flake.lock
  • Because the version which is used by gguf_editor_gui is ^6.9, and 6.9.0 is relatively recent (and not in the previous version of nixpkgs in flake.lock)

---

Make sure to read the contributing guidelines before submitting a PR

[CISC]

$ gguf-dump --help
Traceback (most recent call last):
  File "/nix/store/l06dc60pbanrbm5ksvf0wh3n2q9blw4z-python3.12-gguf-0.0.0/bin/.gguf-dump-wrapped", line 6, in <module>
    from gguf.scripts import gguf_dump_entrypoint
  File "/nix/store/l06dc60pbanrbm5ksvf0wh3n2q9blw4z-python3.12-gguf-0.0.0/lib/python3.12/site-packages/gguf/scripts/__init__.py", line 9, in <module>
    from .gguf_editor_gui import main as gguf_editor_gui_entrypoint
  File "/nix/store/l06dc60pbanrbm5ksvf0wh3n2q9blw4z-python3.12-gguf-0.0.0/lib/python3.12/site-packages/gguf/scripts/gguf_editor_gui.py", line 15, in <module>
    from PySide6.QtWidgets import (
ModuleNotFoundError: No module named 'PySide6'

Interesting, so this is clearly a problem with the way the entrypoints are all made from the same __init__.py, which perhaps is not ideal anyway? Is there a better/simpler way to define them?

* Add `pyside6` to the python dependencies included in `*-extra` devShells
  * Its transitive dependencies are quite big, though (300 MB compressed). Hopefully that is fine with others who use the `*-extra` devShells

Hmmm, yeah, let's hope so.

[CISC]

Interesting, so this is clearly a problem with the way the entrypoints are all made from the same __init__.py, which perhaps is not ideal anyway? Is there a better/simpler way to define them?

So, to answer my own question, I just tried emptying __init__.py, and defining the script entrypoints as the following instead:

[tool.poetry.scripts]
gguf-convert-endian = "gguf.scripts.gguf_convert_endian:main"
gguf-dump = "gguf.scripts.gguf_dump:main"
gguf-set-metadata = "gguf.scripts.gguf_set_metadata:main"
gguf-new-metadata = "gguf.scripts.gguf_new_metadata:main"
gguf-editor-gui = "gguf.scripts.gguf_editor_gui:main"

Built and installed the package and problem seems to be solved, know why it wasn't done like this to begin with?

[CISC]

@compilade Looking at the commit history I think it sort of just evolved into this without any serious consideration as to why, I think clearing __init__.py and pointing directly to the scripts' main function is the solution.

Let me know if you need me to tag the release later.

[compilade]

@CISC I went ahead and changed gguf-py/pyproject.toml as you suggest and removed gguf-py/gguf/scripts/__init__.py because it's not really needed since implicit namespaces added in https://peps.python.org/pep-0420/ (in Python 3.3).

I've tested the scripts after building, and they work fine even when PySide6 is not installed (apart from the gguf-editor-gui script, of course, which requires it).