Sort release filenames naturally on details page (pypi#10438)

* add natsort dependency to project

Signed-off-by: Mike Fiedler <[email protected]>

* add failing test to express desired behavior

Signed-off-by: Mike Fiedler <[email protected]>

* add natural sorting to files passed to template

Signed-off-by: Mike Fiedler <[email protected]>

Author: miketheman

requirements/main.in

@@ -24,6 +24,7 @@ limits
 lxml
 mistune
 msgpack
+natsort
 packaging>=15.2
 paginate>=0.5.2
 paginate_sqlalchemy

requirements/main.txt

@@ -711,6 +711,10 @@ msgpack==1.0.2 \
     --hash=sha256:fae04496f5bc150eefad4e9571d1a76c55d021325dcd484ce45065ebbdd00984 \
     --hash=sha256:fe07bc6735d08e492a327f496b7850e98cb4d112c56df69b0c844dbebcbb47f6
     # via -r requirements/main.in
+natsort==8.0.0 \
+    --hash=sha256:5f5f4ea471d655b1b1611eef1cf0c6d3397095d2d3a1aab7098d6a50e4c3901a \
+    --hash=sha256:a0a4fd71aee20a6d648da61e01180a63f7268e69983d0440bd3ad80ef1ba6981
+    # via -r requirements/main.in
 packaging==21.3 \
     --hash=sha256:dd47c42927d89ab911e606518907cc2d3a1f38bbd026385970643f9c5b8ecfeb \
     --hash=sha256:ef103e05f519cdc783ae24ea4e2e0f508a9c99b2d4969652eed6a2e1ea5bd522

tests/unit/packaging/test_views.py

@@ -13,6 +13,7 @@
 import pretend
 import pytest
 
+from natsort import natsorted
 from pyramid.httpexceptions import HTTPMovedPermanently, HTTPNotFound
 
 from warehouse.packaging import views
@@ -271,6 +272,27 @@ def test_detail_renders(self, monkeypatch, db_request):
             pretend.call("unrendered description", "text/plain")
         ]
 
+    def test_detail_renders_files_natural_sort(self, db_request):
+        """Tests that when a release has multiple versions of Python,
+        the sort order is most recent Python version first."""
+        project = ProjectFactory.create()
+        release = ReleaseFactory.create(project=project, version="3.0")
+        files = [
+            FileFactory.create(
+                release=release,
+                filename="{}-{}-{}.tar.gz".format(
+                    project.name, release.version, py_ver
+                ),
+                python_version="source",
+            )
+            for py_ver in ["cp27", "cp310", "cp39"]  # intentionally out of order
+        ]
+        sorted_files = natsorted(files, reverse=True, key=lambda f: f.filename)
+
+        result = views.release_detail(release, db_request)
+
+        assert result["files"] == sorted_files
+
     def test_license_from_classifier(self, db_request):
         """A license label is added when a license classifier exists."""
         other_classifier = ClassifierFactory.create(

warehouse/packaging/views.py

@@ -10,6 +10,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+from natsort import natsorted
 from pyramid.httpexceptions import HTTPMovedPermanently, HTTPNotFound
 from pyramid.view import view_config
 from sqlalchemy.orm.exc import NoResultFound
@@ -125,7 +126,8 @@ def release_detail(release, request):
         "project": project,
         "release": release,
         "description": description,
-        "files": release.files.all(),
+        # We cannot easily sort naturally in SQL, sort here and pass to template
+        "files": natsorted(release.files.all(), reverse=True, key=lambda f: f.filename),
         "latest_version": project.latest_version,
         "all_versions": project.all_versions,
         "maintainers": maintainers,