From 4cd8cbdb20922fd1144c54467793012ebe468db6 Mon Sep 17 00:00:00 2001
From: Jairo Llopis <jairo@moduon.team>
Date: Tue, 30 Apr 2024 11:36:02 +0100
Subject: [PATCH] feat(buildPythonPackage): support new pyproject format

https://github.com/NixOS/nixpkgs/pull/271597 implemented a new format for python packages that is starting to get traction in nixpkgs/unstable (soon to become NixOS 24.05).

That is a progress towards https://github.com/NixOS/nixpkgs/issues/272178, which would be a massive improvement for dream2nix once completed.

This first step just makes sure that `buildPythonPackage` supports the new arguments properly. Without this change, many dream2nix python derivations fail to build on nixos-unstable right now.

Probably other python auto-builders should leverage these new options when available for the d2n user. That can be added later.

@moduon MT-1075
---
 .../buildPythonPackage/interface.nix          | 50 ++++++++++++++++++-
 1 file changed, 48 insertions(+), 2 deletions(-)

diff --git a/modules/dream2nix/buildPythonPackage/interface.nix b/modules/dream2nix/buildPythonPackage/interface.nix
index 4d96b6eb93..ef2d4dd7fa 100644
--- a/modules/dream2nix/buildPythonPackage/interface.nix
+++ b/modules/dream2nix/buildPythonPackage/interface.nix
@@ -87,11 +87,57 @@ in {
         '';
       };
 
+    pyproject = l.mkOption {
+      type = t.nullOr t.bool;
+      default = null;
+      description = ''
+        Whether the pyproject format should be used. When set to `true`,
+        `pypaBuildHook` will be used, and you can add the required build dependencies
+        from `build-system.requires` to `build-system`. Note that the pyproject
+        format falls back to using `setuptools`, so you can use `pyproject = true`
+        even if the package only has a `setup.py`. When set to `false`, you can
+        use the existing hooks or provide your own logic to build the
+        package. This can be useful for packages that don't support the pyproject
+        format. When unset, the legacy `setuptools` hooks are used for backwards
+        compatibility.
+      '';
+    };
+
+    build-system = l.mkOption {
+      type = t.listOf (t.oneOf [t.str t.path t.package]);
+      default = [];
+      description = ''
+        Build-time only Python dependencies. Items listed in `build-system.requires`/`setup_requires`.
+      '';
+    };
+
+    dependencies = l.mkOption {
+      type = t.listOf (t.oneOf [t.str t.path t.package]);
+      default = [];
+      description = ''
+        List of runtime python dependencies. Aside from propagating dependencies,
+        `buildPythonPackage` also injects code into and wraps executables with the
+        paths included in this list. Items listed in `install_requires` go here.
+      '';
+    };
+
+    optional-dependencies = l.mkOption {
+      type = t.attrsOf (t.oneOf [t.str t.path t.package]);
+      default = {};
+      description = ''
+        Optional feature flagged dependencies. Items listed in `extras_requires` go here.
+      '';
+    };
+
     format = l.mkOption {
-      type = t.str;
-      default = "setuptools";
+      type = t.nullOr t.str;
+      default =
+        if config.buildPythonPackage.pyproject == null
+        then "setuptools"
+        else null;
       description = ''
         Several package formats are supported:
+          `null`: Disable this legacy option and use the new `pyproject` option instead.
           "setuptools" : Install a common setuptools/distutils based package. This builds a wheel.
           "wheel" : Install from a pre-compiled wheel.
           "flit" : Install a flit package. This builds a wheel.