mat2: init at 0.12.0

[dotlambda]

Motivation for this change

fixes #115991
closes #112413

closes #112413

Differences to #112413:

• Python module since e.g. https://0xacab.org/jvoisin/mat2-web uses it
• bubblewrap support
• executable paths are patched in
• path to mime.types is patched in (can be removed once cpython: Pull in the mime-types database #113908 is done)

Things done

• Tested using sandboxing (nix.useSandbox on NixOS, or option sandbox in nix.conf on non-NixOS linux)
• Built on platform(s)
  • NixOS
  • macOS
  • other Linux distributions
• Tested via one or more NixOS test(s) if existing and applicable for the change (look inside nixos/tests)
• Tested compilation of all pkgs that depend on this change using nix-shell -p nixpkgs-review --run "nixpkgs-review wip"
• Tested execution of all binary files (usually in ./result/bin/)
• Determined the impact on package closure size (by running nix path-info -S before and after)
• Ensured that relevant documentation is up to date
• Fits CONTRIBUTING.md.

@nbraud Would you like to be added to meta.maintainers?

[fogti]

The help text of the executable should not contain .mat2-wrapped, but mat2 as usual. This should be possible by patching the mat2 main script, and insert prog="mat2" into the arguments of argparse.ArgumentParser, according to takluyver/pynsist#92

[r-rmcgibbo]

Result of nixpkgs-review pr 116005 at 71a31efd run on x86_64-linux 1

2 packages built successfully:

• mat2
(python38Packages.mat2)
• python39Packages.mat2

---

Result of nixpkgs-review pr 116005 at 71a31efd run on aarch64-linux 1

2 packages built successfully:

• mat2
(python38Packages.mat2)
• python39Packages.mat2

[fogti]

In _get_bwrap_args (libmat2/bubblewrap.py), /etc/ld.so.cache is mounted into the bubblewrap call. This should be removed, too, as it is unneeded, because we hardcoded all executables we call to nix store paths, which contains executables which don't use /etc/ld.so.cache.

[fogti]

The imports functools and shutil can be removed from the following files: libmat2/exiftool.py, libmat2/video.py.

[fogti]

I don't think this currently installs the dolphin and nautilus extensions. This isn't strictly needed, but it would be a good idea to create an additional derivation for the nautilus extension, as it requires additional python modules, and is pretty independent from the rest (it only depends on libmat2, GTK, GDK, Nautilus). The dolphin extension is far easier, as it is just a .desktop file. imo this could also be placed in another derivation, which installs just the .desktop file, so that the extensions can be added and removed without needing to rebuild the main package.

[fogti]

This argument list should be sorted.

[SuperSandro2000]

It would be nice but is not strictly required.

[dotlambda]

They are more or less ordered by appearance inthe expression.

[fogti]

The tests hang at Executing pythonImportsCheckPhase.

[dotlambda]

The tests hang at Executing pythonImportsCheckPhase.

works for me ;-)

[dotlambda]

I don't think this currently installs the dolphin and nautilus extensions.

Now at least the dolphin one is installed.

[dotlambda]

I guess this can't be done using placeholder "out" within substituteAll?

[fogti]

In sections where you can use the $out variable, you shouldn't use placeholder "out" at all.

[dotlambda]

I made the dolphin integration optional as it increases the closure size by about 500MiB (50%).

I also tried getting the nautilus extension to work by installing natulis as well as nautilus-python using nix-env and putting the script from nautilus/mat2.py in $out/share/nautilus-python/extensions. But nautilus didn't even print any error messages. I have no clue how nautilus-python works. Maybe someone from @NixOS/gnome can help?

[jtojnar]

IIRC, You need NAUTILUS_EXTENSION_DIR environment variable set up for Nautilus to find nautilus-python. GNOME NixOS module sets that variable in a way that finds extensions added to environment.systemPackages:

nixpkgs/nixos/modules/services/x11/desktop-managers/gnome3.nix

Line 448 in e5deabe

environment.sessionVariables.NAUTILUS_EXTENSION_DIR = "${config.system.path}/lib/nautilus/extensions-3.0";

Then you also need to install the python scripts to a directory accessible from $XDG_DATA_DIRS, again environment.systemPackages will work:

nixpkgs/nixos/modules/services/x11/desktop-managers/gnome3.nix

Lines 453 to 455 in e5deabe

	environment.pathsToLink = [
	"/share/nautilus-python/extensions"
	];

But if you have ~/.nix-profile/share in XDG_DATA_DIRS, nix-env should work as well.

Nautilus, Gdk and Gtk typelibs should be inherited from Nautilus so no need to add these dependencies but libmat2 might be problematic. If nautilus-python imports the script, you might need wrapPython:

https://github.com/NixOS/nixpkgs/blob/e5deabe68b7f85467d2f8519efe1daabbd9a86b5/pkgs/development/interpreters/python/wrap-python.nix

[dotlambda]

I don't have the motivation to test the nautilus extension. If someone using GNOME wants to do that, go ahead.
So from my point of view, this is done.

@ofborg eval

[dotlambda]

Does anyone want to work on Nautilus support? Otherwise I'll merge this as is.

[fogti]

I don't require Nautilus support, thus I'm fine with it.

[dotlambda]

I tried setting NAUTILUS_EXTENSION_DIR=~/.nix-profile/lib/nautilus/extensions-3.0 but get

$ nautilus
ImportError: could not import gobject (error was: ModuleNotFoundError("No module named 'gi'"))

(org.gnome.Nautilus:5580): Nautilus-Python-WARNING **: 12:28:13.527: pygobject initialization failed

(org.gnome.Nautilus:5580): Nautilus-Python-WARNING **: 12:28:13.527: nautilus_python_init_python failed

That makes me suspect that nautilus-python is just broken.
cc @worldofpeace @etu

[dotlambda]

@FRidh Is there a better way to patch sys.path without creating a bash wrapper?

[dotlambda]

Does anything remain to be done before this is merged?

[fogti]

LGTM

[SuperSandro2000]

This is a semi-automatic executed nixpkgs-review with nixpkgs-review-checks extension. It is checked by a human on a best effort basis and does not build all packages (e.g. lumo, tensorflow or pytorch).
If you have any questions or problems please reach out to SuperSandro2000 on IRC.

Result of nixpkgs-review pr 116005 run on x86_64-linux 1

3 packages built:

• mat2 (python38Packages.mat2)
• metadata-cleaner
• python39Packages.mat2