pypa: Add isSdistFileName

pyproject-nix · Nov 3, 2023 · f1e9fee · f1e9fee
1 parent 8929485
commit f1e9fee
Show file tree

Hide file tree

Showing 2 changed files with 46 additions and 2 deletions.
diff --git a/lib/pypa.nix b/lib/pypa.nix
@@ -6,6 +6,9 @@ let
 
   matchWheelFileName = match "([^-]+)-([^-]+)(-([[:digit:]][^-]*))?-([^-]+)-([^-]+)-(.+).whl";
 
+  # PEP-625 only specifies .tar.gz as valid extension but .zip is also fairly widespread.
+  matchSdistFileName = match "([^-]+)-(.+)(\.tar\.gz|\.zip)";
+
   # Tag normalization documented in
   # https://packaging.python.org/en/latest/specifications/platform-compatibility-tags/#details
   normalizedImpls = {
@@ -92,6 +95,18 @@ lib.fix (self: {
       rest = mAt 2;
     };
 
+  /* Check whether string is a sdist file or not.
+
+     Type: isSdistFileName :: string -> bool
+
+     Example:
+     # isSdistFileName "cryptography-41.0.1.tar.gz"
+     true
+  */
+  isSdistFileName =
+    # The filename string
+    name: matchSdistFileName name != null;
+
   /* Check whether string is a wheel file or not.
 
      Type: isWheelFileName :: string -> bool
@@ -100,7 +115,9 @@ lib.fix (self: {
      # isWheelFileName "cryptography-41.0.1-cp37-abi3-manylinux_2_17_aarch64.manylinux2014_aarch64.whl"
      true
   */
-  isWheelFileName = name: matchWheelFileName name != null;
+  isWheelFileName =
+    # The filename string
+    name: matchWheelFileName name != null;
 
   /* Parse PEP-427 wheel file names.
 

diff --git a/lib/test_pypa.nix b/lib/test_pypa.nix
@@ -1,6 +1,6 @@
 { lib, pypa, mocks, ... }:
 let
-  inherit (pypa) normalizePackageName parsePythonTag parseABITag parseWheelFileName isWheelFileName isPythonTagCompatible isABITagCompatible isPlatformTagCompatible isWheelFileCompatible selectWheels;
+  inherit (pypa) normalizePackageName parsePythonTag parseABITag parseWheelFileName isWheelFileName isPythonTagCompatible isABITagCompatible isPlatformTagCompatible isWheelFileCompatible selectWheels isSdistFileName;
   inherit (lib) mapAttrs';
 
 in
@@ -145,6 +145,33 @@ in
     };
   };
 
+  isSdistFileName = {
+    testSimpleZip = {
+      expr = isSdistFileName "debugpy-1.6.7.zip";
+      expected = true;
+    };
+
+    testSimpleTarGz = {
+      expr = isSdistFileName "debugpy-1.6.7.tar.gz";
+      expected = true;
+    };
+
+    testSimpleTarBz2 = {
+      expr = isSdistFileName "debugpy-1.6.7.tar.bz2";
+      expected = false;
+    };
+
+    testUniversalWheel = {
+      expr = isSdistFileName "distribution-1.0-1-py27-none-any.whl";
+      expected = false;
+    };
+
+    testWheel = {
+      expr = isSdistFileName "cryptography-41.0.1-cp37-abi3-manylinux_2_17_aarch64.manylinux2014_aarch64.whl";
+      expected = false;
+    };
+  };
+
   isPythonTagCompatible = {
     testPython = {
       expr = isPythonTagCompatible mocks.cpythonLinux38 (parsePythonTag "py3");