treewide: add explicit format attribute for Python packages (#421660)

2025-07-02 10:35:11 +02:00
parent bfa4f7bad6 d2e9be2b07
commit b50d97e6b3
662 changed files with 719 additions and 7 deletions
@@ -61,6 +61,10 @@
 - `reaction` has been updated to version 2, which includes some breaking changes.
  For more information, [check the release article](https://blog.ppom.me/en-reaction-v2).

+- The `buildPythonPackage` and `buildPythonApplication` functions now require
+  an explicit `format` attribute. Previously the default format used setuptools
+  and called `setup.py` from the source tree, which is deprecated.
+  The modern alternative is to configure `pyproject = true` with `build-system = [ setuptools ]`.

 ### Deprecations {#sec-nixpkgs-release-25.11-lib-deprecations}

@@ -137,6 +137,7 @@ let
  nixos-taskserver =
    with pkgs.python3.pkgs;
    buildPythonApplication {
+      format = "setuptools";
      name = "nixos-taskserver";

      src = pkgs.runCommand "nixos-taskserver-src" { preferLocalBuild = true; } ''
@@ -6,6 +6,7 @@ import ../make-test-python.nix {
    let
      testLib = pkgs.python3Packages.buildPythonPackage {
        name = "confinement-testlib";
+        format = "setuptools";
        unpackPhase = ''
          cat > setup.py <<EOF
          from setuptools import setup
@@ -8,6 +8,7 @@ with pythonPackages;
 buildPythonApplication rec {
  pname = "greg";
  version = "0.4.8";
+  format = "setuptools";

  disabled = !isPy3k;

@@ -17,6 +17,7 @@
 buildPythonApplication {
  pname = "hushboard";
  version = "unstable-2021-03-17";
+  format = "setuptools";

  src = fetchFromGitHub {
    owner = "stuartlangridge";
@@ -8,6 +8,7 @@
 python3Packages.buildPythonApplication rec {
  pname = "Mopidy-Bandcamp";
  version = "1.1.5";
+  format = "setuptools";
  src = fetchPypi {
    inherit pname version;
    hash = "sha256-wg9zcOKfZQRhpyA1Cu5wvdwKpmrlcr2m9mrqBHgUXAQ=";
@@ -8,6 +8,7 @@
 python3Packages.buildPythonApplication rec {
  pname = "Mopidy-Iris";
  version = "3.69.3";
+  format = "setuptools";

  src = fetchPypi {
    inherit pname version;
@@ -8,6 +8,7 @@
 python3Packages.buildPythonApplication rec {
  pname = "mopidy-jellyfin";
  version = "1.0.6";
+  format = "setuptools";

  src = fetchPypi {
    inherit version;
@@ -8,6 +8,7 @@
 python3Packages.buildPythonApplication rec {
  pname = "Mopidy-Local";
  version = "3.3.0";
+  format = "setuptools";

  src = fetchPypi {
    inherit version;
@@ -9,6 +9,7 @@
 pythonPackages.buildPythonApplication rec {
  pname = "Mopidy-Moped";
  version = "0.7.1";
+  format = "setuptools";

  src = fetchPypi {
    inherit pname version;
@@ -14,6 +14,7 @@
 pythonPackages.buildPythonApplication rec {
  pname = "mopidy";
  version = "3.4.2";
+  format = "setuptools";

  src = fetchFromGitHub {
    owner = "mopidy";
@@ -8,6 +8,7 @@
 pythonPackages.buildPythonApplication rec {
  pname = "Mopidy-Mopify";
  version = "1.7.3";
+  format = "setuptools";

  src = fetchPypi {
    inherit pname version;
@@ -8,6 +8,7 @@
 python3Packages.buildPythonApplication rec {
  pname = "Mopidy-MPD";
  version = "3.3.0";
+  format = "setuptools";

  src = fetchPypi {
    inherit pname version;
@@ -8,6 +8,7 @@
 python3Packages.buildPythonApplication rec {
  pname = "mopidy-mpris";
  version = "3.0.3";
+  format = "setuptools";

  src = fetchPypi {
    inherit version;
@@ -8,6 +8,7 @@
 pythonPackages.buildPythonApplication rec {
  pname = "mopidy-muse";
  version = "0.0.33";
+  format = "setuptools";

  src = fetchPypi {
    inherit version;
@@ -8,6 +8,7 @@
 pythonPackages.buildPythonApplication rec {
  pname = "mopidy-musicbox-webclient";
  version = "3.1.0";
+  format = "setuptools";

  src = fetchFromGitHub {
    owner = "pimusicbox";
@@ -8,6 +8,7 @@
 pythonPackages.buildPythonApplication rec {
  pname = "Mopidy-Notify";
  version = "0.2.1";
+  format = "setuptools";

  src = fetchPypi {
    inherit pname version;
@@ -8,6 +8,7 @@
 python3Packages.buildPythonApplication rec {
  pname = "mopidy-podcast";
  version = "3.0.1";
+  format = "setuptools";

  src = fetchPypi {
    inherit version;
@@ -8,6 +8,7 @@
 python3Packages.buildPythonApplication rec {
  pname = "Mopidy-Scrobbler";
  version = "2.0.1";
+  format = "setuptools";

  src = fetchPypi {
    inherit pname version;
@@ -8,6 +8,7 @@
 python3Packages.buildPythonApplication rec {
  pname = "mopidy-somafm";
  version = "2.0.2";
+  format = "setuptools";

  src = fetchPypi {
    inherit version;
@@ -8,6 +8,7 @@
 pythonPackages.buildPythonApplication rec {
  pname = "mopidy-soundcloud";
  version = "3.0.2";
+  format = "setuptools";

  src = fetchFromGitHub {
    owner = "mopidy";
@@ -8,6 +8,7 @@
 pythonPackages.buildPythonApplication rec {
  pname = "mopidy-subidy";
  version = "1.0.0";
+  format = "setuptools";

  src = fetchFromGitHub {
    owner = "Prior99";
@@ -8,6 +8,7 @@
 python3Packages.buildPythonApplication rec {
  pname = "mopidy-tunein";
  version = "1.1.0";
+  format = "setuptools";

  src = fetchPypi {
    inherit version;
@@ -10,6 +10,7 @@
 buildPythonApplication rec {
  pname = "cryptop";
  version = "0.2.0";
+  format = "setuptools";

  src = fetchPypi {
    inherit pname version;
@@ -16,6 +16,7 @@
 buildPythonApplication rec {
  pname = "formiko";
  version = "1.5.0";
+  format = "setuptools";

  src = fetchFromGitHub {
    owner = "ondratu";
@@ -8,6 +8,7 @@
 python3.pkgs.buildPythonPackage rec {
  pname = "coq-jupyter";
  version = "1.6.0";
+  format = "setuptools";

  src = fetchFromGitHub {
    owner = "EugeneLoy";
@@ -9,6 +9,7 @@ with python3Packages;
 buildPythonPackage rec {
  pname = "octave-kernel";
  version = "0.34.2";
+  format = "setuptools";

  src = fetchPypi {
    pname = "octave_kernel";
@@ -22,6 +22,7 @@ in
 python3.pkgs.buildPythonApplication rec {
  pname = "textext";
  version = "1.11.1";
+  format = "setuptools";

  src = fetchFromGitHub {
    owner = "textext";
@@ -10,6 +10,7 @@
 python3Packages.buildPythonApplication rec {
  pname = "kcc";
  version = "5.5.1";
+  format = "setuptools";

  src = fetchPypi {
    inherit version;
@@ -8,6 +8,7 @@
 python3Packages.buildPythonApplication rec {
  pname = "veusz";
  version = "4.1";
+  format = "setuptools";

  src = fetchPypi {
    inherit pname version;
@@ -7,6 +7,7 @@
 python3Packages.buildPythonApplication {
  pname = "avell-unofficial-control-center";
  version = "1.0.4";
+  format = "setuptools";

  src = fetchFromGitHub {
    owner = "rodgomesc";
@@ -10,6 +10,7 @@
 buildPythonApplication rec {
  pname = "dmensamenu";
  version = "1.2.2";
+  format = "setuptools";

  src = fetchFromGitHub {
    owner = "dotlambda";
@@ -34,6 +34,7 @@ in
 python3.pkgs.buildPythonApplication rec {
  pname = "electrum";
  version = "4.5.8";
+  format = "setuptools";

  src = fetchurl {
    url = "https://download.electrum.org/${version}/Electrum-${version}.tar.gz";
@@ -34,6 +34,7 @@ in
 python3.pkgs.buildPythonApplication {
  pname = "electrum-grs";
  inherit version;
+  format = "setuptools";

  src = fetchFromGitHub {
    owner = "Groestlcoin";
@@ -48,6 +48,7 @@ in
 python3.pkgs.buildPythonApplication {
  pname = "electrum-ltc";
  inherit version;
+  format = "setuptools";

  src = fetchurl {
    url = "https://electrum-ltc.org/download/Electrum-LTC-${version}.tar.gz";
@@ -16,6 +16,7 @@
 buildPythonApplication rec {
  pname = "hovercraft";
  version = "2.7";
+  format = "setuptools";
  disabled = !isPy3k;

  src = fetchFromGitHub {
@@ -9,6 +9,7 @@
 python3Packages.buildPythonApplication rec {
  pname = "hue-plus";
  version = "1.4.5";
+  format = "setuptools";

  src = fetchFromGitHub {
    owner = "kusti8";
@@ -11,6 +11,7 @@
 buildPythonApplication rec {
  pname = "mu-repo";
  version = "1.9.0";
+  format = "setuptools";

  src = fetchFromGitHub {
    owner = "fabioz";
@@ -14,6 +14,7 @@
    mkDerivationWith buildPythonPackage rec {
      pname = "plover";
      version = "4.0.2";
+      format = "setuptools";

      meta = with lib; {
        broken = stdenv.hostPlatform.isDarwin;
@@ -11,6 +11,7 @@
 buildPythonApplication rec {
  pname = "remarkable-mouse";
  version = "7.1.1";
+  format = "setuptools";

  src = fetchPypi {
    inherit pname version;
@@ -11,6 +11,7 @@
 buildPythonApplication rec {
  pname = "termdown";
  version = "1.18.0";
+  format = "setuptools";

  src = fetchFromGitHub {
    owner = "trehn";
@@ -16,6 +16,7 @@
 buildPythonApplication {
  pname = "termpdf.py";
  version = "2022-03-28";
+  format = "setuptools";

  src = fetchFromGitHub {
    owner = "dsanson";
@@ -10,6 +10,7 @@
 buildPythonApplication rec {
  pname = "twitch-chat-downloader";
  version = "2.5.4";
+  format = "setuptools";

  # NOTE: Using maintained fork because upstream has stopped working, and it has
  # not been updated in a while.
@@ -52,6 +52,7 @@
 buildPythonApplication rec {
  pname = "visidata";
  version = "3.1.1";
+  format = "setuptools";

  src = fetchFromGitHub {
    owner = "saulpw";
@@ -6,6 +6,7 @@

 pythonPackages.buildPythonApplication rec {
  version = "1.4";
+  format = "setuptools";
  pname = "wikicurses";

  src = fetchFromGitHub {
@@ -12,6 +12,7 @@
 buildPythonApplication rec {
  pname = "yokadi";
  version = "1.3.0";
+  format = "setuptools";

  src = fetchurl {
    url = "https://yokadi.github.io/download/${pname}-${version}.tar.gz";
@@ -6,6 +6,7 @@
 python3Packages.buildPythonApplication {
  pname = "av-98";
  version = "1.0.2dev";
+  format = "setuptools";

  src = fetchgit {
    url = "https://tildegit.org/solderpunk/AV-98.git";
@@ -12,6 +12,7 @@ mkDerivationWith python3Packages.buildPythonApplication rec {

  pname = "webmacs";
  version = "0.8";
+  format = "setuptools";

  disabled = python3Packages.isPy27;

@@ -11,6 +11,7 @@ with pythonPackages;
 buildPythonApplication rec {
  pname = "rss2email";
  version = "3.14";
+  format = "setuptools";

  propagatedBuildInputs = [
    feedparser
@@ -17,6 +17,7 @@
 python3Packages.buildPythonApplication rec {
  pname = "gns3-gui";
  inherit version;
+  format = "setuptools";

  src = fetchFromGitHub {
    inherit hash;
@@ -19,6 +19,7 @@
 python3Packages.buildPythonApplication {
  pname = "gns3-server";
  inherit version;
+  format = "setuptools";

  src = fetchFromGitHub {
    inherit hash;
@@ -12,6 +12,7 @@
 buildPythonApplication rec {
  pname = "tg";
  version = "0.19.0";
+  format = "setuptools";
  disabled = pythonOlder "3.8";

  src = fetchFromGitHub {
@@ -18,6 +18,7 @@ let
  pycrypto = python3Packages.buildPythonPackage rec {
    pname = "pycrypto";
    version = "2.6.1-13.1";
+    format = "setuptools";

    src = fetchgit {
      url = "https://salsa.debian.org/sramacher/python-crypto.git";
@@ -25,6 +25,7 @@
 python3Packages.buildPythonApplication rec {
  pname = "mailnag";
  version = "2.2.0";
+  format = "setuptools";

  src = fetchFromGitHub {
    owner = "pulb";
@@ -9,6 +9,7 @@
 python3Packages.buildPythonPackage rec {
  pname = "mailnag-goa-plugin";
  version = "2.0.0";
+  format = "setuptools";

  src = fetchFromGitHub {
    owner = "pulb";
@@ -34,6 +34,7 @@ in
 python3Packages.buildPythonApplication {
  pname = "mkchromecast-unstable";
  version = "2022-10-31";
+  format = "setuptools";

  src = fetchFromGitHub {
    owner = "muammar";
@@ -22,6 +22,7 @@ let
    pypkgs.buildPythonPackage rec {
      inherit pname;
      version = "2.2.0";
+      format = "setuptools";

      src = fetchurl {
        url = "http://download.deluge-torrent.org/source/${lib.versions.majorMinor version}/deluge-${version}.tar.xz";
@@ -16,6 +16,7 @@
 buildPythonApplication rec {
  pname = "acd_cli";
  version = "0.3.2";
+  format = "setuptools";

  doCheck = false;

@@ -10,6 +10,7 @@ python3Packages.buildPythonPackage rec {
  pname = "qnotero";

  version = "2.3.1";
+  format = "setuptools";

  src = fetchFromGitHub {
    owner = "ealbiter";
@@ -25,6 +25,7 @@ let
  js8py = buildPythonPackage rec {
    pname = "js8py";
    version = "0.1.1";
+    format = "setuptools";

    src = fetchFromGitHub {
      owner = "jketterl";
@@ -83,6 +84,7 @@ in
 buildPythonApplication rec {
  pname = "openwebrx";
  version = "1.2.2";
+  format = "setuptools";

  src = fetchFromGitHub {
    owner = "jketterl";
@@ -10,6 +10,7 @@
 python3Packages.buildPythonApplication rec {
  pname = "obitools3";
  version = "3.0.1b11";
+  format = "setuptools";

  src = fetchurl {
    url = "https://git.metabarcoding.org/obitools/${pname}/repository/v${version}/archive.tar.gz";
@@ -18,6 +18,7 @@
 buildPythonApplication rec {
  pname = "MAVProxy";
  version = "1.8.71";
+  format = "setuptools";

  src = fetchFromGitHub {
    owner = "ArduPilot";
@@ -10,6 +10,7 @@
 buildPythonApplication rec {
  pname = "git-annex-metadata-gui";
  version = "0.2.0";
+  format = "setuptools";

  src = fetchFromGitHub {
    owner = "alpernebbi";
@@ -10,6 +10,7 @@
 buildPythonApplication rec {
  pname = "git-annex-remote-dbx";
  version = "1.0.3";
+  format = "setuptools";

  src = fetchPypi {
    inherit pname version;
@@ -11,6 +11,7 @@
 buildPythonApplication rec {
  pname = "git-archive-all";
  version = "1.23.1";
+  format = "setuptools";

  src = fetchFromGitHub {
    owner = "Kentzo";
@@ -8,6 +8,7 @@
 buildPythonApplication rec {
  pname = "git-imerge";
  version = "1.2.0";
+  format = "setuptools";

  src = fetchPypi {
    inherit pname version;
@@ -9,6 +9,7 @@
 buildPythonApplication rec {
  pname = "gitup";
  version = "0.5.1";
+  format = "setuptools";

  src = fetchPypi {
    inherit pname version;
@@ -11,6 +11,7 @@
 buildPythonApplication rec {
  pname = "git-review";
  version = "2.5.0";
+  format = "setuptools";

  # Manually set version because prb wants to get it from the git
  # upstream repository (and we are installing from tarball instead)
@@ -9,6 +9,7 @@

 buildPythonApplication rec {
  version = "0.16.6.1";
+  format = "setuptools";
  pname = "gita";

  src = fetchFromGitHub {
@@ -20,6 +20,7 @@
 buildPythonApplication rec {
  pname = "jellyfin-mpv-shim";
  version = "2.9.0";
+  format = "setuptools";

  src = fetchPypi {
    inherit pname version;
@@ -26,6 +26,7 @@ let
  };
 in
 mkDerivationWith python3.pkgs.buildPythonApplication {
+  format = "setuptools";
  inherit pname version src;

  outputs = [ "out" ]; # "lib" can't be split
@@ -17,6 +17,7 @@
 buildPythonApplication rec {
  pname = "plex-mpv-shim";
  version = "1.11.0";
+  format = "setuptools";

  src = fetchFromGitHub {
    owner = "iwalton3";
@@ -17,6 +17,7 @@
 python3Packages.buildPythonApplication rec {
  pname = "tartube";
  version = "2.5.100";
+  format = "setuptools";

  src = fetchFromGitHub {
    owner = "axcore";
@@ -7,6 +7,7 @@
 python3Packages.buildPythonApplication rec {
  pname = "i3altlayout";
  version = "0.3";
+  format = "setuptools";

  src = fetchPypi {
    inherit pname version;
@@ -8,6 +8,7 @@
 buildPythonPackage rec {
  pname = "i3-balance-workspace";
  version = "1.8.6";
+  format = "setuptools";

  src = fetchPypi {
    inherit pname version;
@@ -14,6 +14,7 @@
 buildPythonApplication rec {
  pname = "i3-resurrect";
  version = "1.4.5";
+  format = "setuptools";

  src = fetchPypi {
    inherit pname version;
@@ -7,6 +7,7 @@
 python3Packages.buildPythonApplication {
  pname = "accelergy";
  version = "unstable-2022-05-03";
+  format = "setuptools";

  src = fetchFromGitHub {
    owner = "Accelergy-Project";
@@ -9,6 +9,7 @@ with python3.pkgs;
 buildPythonApplication rec {
  pname = "adafruit-ampy";
  version = "1.1.0";
+  format = "setuptools";

  src = fetchPypi {
    inherit pname version;
@@ -7,6 +7,7 @@
 python3Packages.buildPythonApplication rec {
  pname = "addic7ed-cli";
  version = "1.4.6";
+  format = "setuptools";

  src = fetchPypi {
    inherit pname version;
@@ -9,6 +9,7 @@ with python3.pkgs;
 buildPythonApplication rec {
  pname = "almonds";
  version = "1.25b";
+  format = "setuptools";

  src = fetchFromGitHub {
    owner = "Tenchi2xh";
@@ -13,6 +13,7 @@ let
  description = "Advanced typing practice program";
 in
 python3Packages.buildPythonApplication {
+  format = "setuptools";
  inherit pname version;

  src = fetchFromGitLab {
@@ -11,6 +11,7 @@
 python3.pkgs.buildPythonApplication rec {
  pname = "anime-downloader";
  version = "5.0.14";
+  format = "setuptools";

  src = fetchFromGitHub {
    owner = "anime-dl";
@@ -7,6 +7,7 @@
 python3Packages.buildPythonApplication {
  pname = "antfs-cli";
  version = "unstable-2017-02-11";
+  format = "setuptools";

  meta = with lib; {
    homepage = "https://github.com/Tigge/antfs-cli";
@@ -147,6 +147,7 @@ in
 buildPythonPackage rec {
  pname = "apache-airflow";
  inherit version;
+  format = "setuptools";
  src = airflow-src;

  disabled = pythonOlder "3.7";
@@ -11,6 +11,7 @@
 python3.pkgs.buildPythonApplication rec {
  pname = "apksigcopier";
  version = "1.1.1";
+  format = "setuptools";

  src = fetchFromGitHub {
    owner = "obfusk";
@@ -18,6 +18,7 @@ let
  };
 in
 python3Packages.buildPythonApplication {
+  format = "setuptools";
  inherit pname version src;

  nativeBuildInputs = [ installShellFiles ];
@@ -16,6 +16,7 @@ in
 buildPythonApplication rec {
  pname = "arandr";
  version = "0.1.11";
+  format = "setuptools";

  src = fetchFromGitLab {
    owner = "arandr";
@@ -7,6 +7,7 @@
 python3Packages.buildPythonApplication rec {
  pname = "arxiv-latex-cleaner";
  version = "1.0.8";
+  format = "setuptools";

  src = fetchFromGitHub {
    owner = "google-research";
@@ -14,6 +14,7 @@
 python3Packages.buildPythonApplication rec {
  pname = "autokey";
  version = "0.96.0";
+  format = "setuptools";

  src = fetchFromGitHub {
    owner = "autokey";
@@ -9,6 +9,7 @@
 python3Packages.buildPythonApplication rec {
  pname = "aws-shell";
  version = "0.2.2";
+  format = "setuptools";

  src = fetchFromGitHub {
    owner = "awslabs";
@@ -25,6 +25,7 @@ let
        });
        python-dateutil = prev.python-dateutil.overridePythonAttrs (prev: rec {
          version = "2.8.2";
+          format = "setuptools";
          pyproject = null;
          src = prev.src.override {
            inherit version;
@@ -20,6 +20,7 @@
 python3Packages.buildPythonApplication rec {
  pname = "ayatana-webmail";
  version = "24.5.17";
+  format = "setuptools";

  src = fetchFromGitHub {
    owner = "AyatanaIndicators";
@@ -142,6 +142,7 @@ py.pkgs.toPythonApplication (
  py.pkgs.buildAzureCliPackage rec {
    pname = "azure-cli";
    inherit version src;
+    format = "setuptools";

    sourceRoot = "${src.name}/src/azure-cli";

@@ -28,6 +28,7 @@ let
      # core and the actual application are highly coupled
      azure-cli-core = buildAzureCliPackage {
        pname = "azure-cli-core";
+        format = "setuptools";
        inherit version src;

        sourceRoot = "${src.name}/src/azure-cli-core";
@@ -99,6 +100,7 @@ let
      azure-cli-telemetry = buildAzureCliPackage {
        pname = "azure-cli-telemetry";
        version = "1.1.0";
+        format = "setuptools";
        inherit src;

        sourceRoot = "${src.name}/src/azure-cli-telemetry";
@@ -10,6 +10,7 @@ let
 in
 python3Packages.buildPythonApplication {
  inherit pname version;
+  format = "setuptools";

  src = fetchPypi {
    inherit version;
@@ -7,6 +7,7 @@
 python3Packages.buildPythonApplication {
  pname = "bashplotlib";
  version = "2021-03-31";
+  format = "setuptools";

  src = fetchFromGitHub {
    owner = "glamp";
@@ -9,6 +9,7 @@ with python3.pkgs;
 buildPythonApplication rec {
  pname = "bkyml";
  version = "1.4.3";
+  format = "setuptools";

  src = fetchPypi {
    inherit pname version;
@@ -7,6 +7,7 @@
 python3Packages.buildPythonApplication rec {
  pname = "bmaptool";
  version = "3.8.0";
+  format = "setuptools";

  src = fetchFromGitHub {
    owner = "yoctoproject";
@@ -7,6 +7,7 @@
 python3Packages.buildPythonApplication rec {
  pname = "btlejack";
  version = "2.1.1";
+  format = "setuptools";

  src = fetchFromGitHub {
    owner = "virtualabs";
@@ -20,6 +20,7 @@
 python3Packages.buildPythonApplication rec {
  pname = "bubblemail";
  version = "1.9";
+  format = "setuptools";

  src = fetchFromGitLab {
    domain = "framagit.org";
--- a/Show More
+++ b/Show More