fix: include time on longer runs (#1014)

* fix: include time on longer runs

Signed-off-by: Henry Schreiner <[email protected]>

* fix: include time on final summary, too

Signed-off-by: Henry Schreiner <[email protected]>

---------

Signed-off-by: Henry Schreiner <[email protected]>

Author: henryiii

.pre-commit-config.yaml

@@ -42,6 +42,7 @@ repos:
           - attrs
           - colorlog
           - dependency-groups>=1.2
+          - humanize
           - jinja2
           - orjson # Faster mypy
           - packaging

nox/sessions.py

@@ -15,6 +15,7 @@
 from __future__ import annotations
 
 import contextlib
+import datetime
 import enum
 import hashlib
 import os
@@ -23,13 +24,16 @@
 import shutil
 import subprocess
 import sys
+import time
 import unicodedata
 from typing import (
     TYPE_CHECKING,
     Any,
     NoReturn,
 )
 
+import humanize
+
 import nox.command
 import nox.virtualenv
 from nox.logger import logger
@@ -1100,9 +1104,11 @@ def execute(self) -> Result:
                         f"Prerequisite session {dependency.friendly_name} was not"
                         " successful"
                     ),
+                    duration=0,
                 )
                 return self.result
 
+        start = time.perf_counter()
         try:
             cwd = os.path.realpath(os.path.dirname(self.global_config.noxfile))
 
@@ -1113,42 +1119,83 @@ def execute(self) -> Result:
                 self.func(session)
 
             # Nothing went wrong; return a success.
-            self.result = Result(self, Status.SUCCESS)
+            self.result = Result(
+                self, Status.SUCCESS, duration=time.perf_counter() - start
+            )
 
         except nox.virtualenv.InterpreterNotFound as exc:
             if self.global_config.error_on_missing_interpreters:
-                self.result = Result(self, Status.FAILED, reason=str(exc))
+                self.result = Result(
+                    self,
+                    Status.FAILED,
+                    reason=str(exc),
+                    duration=time.perf_counter() - start,
+                )
             else:
                 logger.warning(
                     "Missing interpreters will error by default on CI systems."
                 )
-                self.result = Result(self, Status.SKIPPED, reason=str(exc))
+                self.result = Result(
+                    self,
+                    Status.SKIPPED,
+                    reason=str(exc),
+                    duration=time.perf_counter() - start,
+                )
 
         except _SessionQuit as exc:
-            self.result = Result(self, Status.ABORTED, reason=str(exc))
+            self.result = Result(
+                self,
+                Status.ABORTED,
+                reason=str(exc),
+                duration=time.perf_counter() - start,
+            )
 
         except _SessionSkip as exc:
-            self.result = Result(self, Status.SKIPPED, reason=str(exc))
+            self.result = Result(
+                self,
+                Status.SKIPPED,
+                reason=str(exc),
+                duration=time.perf_counter() - start,
+            )
 
         except nox.command.CommandFailed:
-            self.result = Result(self, Status.FAILED)
+            self.result = Result(
+                self, Status.FAILED, duration=time.perf_counter() - start
+            )
 
         except KeyboardInterrupt:
             logger.error(f"Session {self.friendly_name} interrupted.")
             raise
 
         except Exception as exc:
             logger.exception(f"Session {self.friendly_name} raised exception {exc!r}")
-            self.result = Result(self, Status.FAILED)
+            self.result = Result(
+                self, Status.FAILED, duration=time.perf_counter() - start
+            )
 
         return self.result
 
 
+def _duration_str(seconds: float, text: str) -> str:
+    time_str = humanize.naturaldelta(datetime.timedelta(seconds=seconds))
+
+    # Might be "a moment" if short, return empty string in that case
+    if time_str == "a moment":
+        return ""
+
+    return text.format(time=time_str)
+
+
 class Result:
     """An object representing the result of a session."""
 
     def __init__(
-        self, session: SessionRunner, status: Status, reason: str | None = None
+        self,
+        session: SessionRunner,
+        status: Status,
+        reason: str | None = None,
+        *,
+        duration: float = 0.0,
     ) -> None:
         """Initialize the Result object.
 
@@ -1157,10 +1204,12 @@ def __init__(
                 The session runner which ran.
             status (~nox.sessions.Status): The final result status.
             reason (str): Additional info.
+            duration (float): Time taken in seconds.
         """
         self.session = session
         self.status = status
         self.reason = reason
+        self.duration = duration
 
     def __bool__(self) -> bool:
         return self.status.value > 0
@@ -1173,12 +1222,12 @@ def imperfect(self) -> str:
             str: A word or phrase representing the status.
         """
         if self.status == Status.SUCCESS:
-            return "was successful"
+            return "was successful" + _duration_str(self.duration, " in {time}")
 
         status = self.status.name.lower()
         if self.reason:
-            return f"{status}: {self.reason}"
-
+            duration_err = _duration_str(self.duration, " (took {time})")
+            return f"{status}: {self.reason}{duration_err}"
         return status
 
     def log(self, message: str) -> None:
@@ -1208,4 +1257,5 @@ def serialize(self) -> dict[str, Any]:
             "result": self.status.name.lower(),
             "result_code": self.status.value,
             "signatures": self.session.signatures,
+            "duration": self.duration,
         }

nox/tasks.py

@@ -29,7 +29,7 @@
 from nox._version import InvalidVersionSpecifier, VersionCheckFailed, check_nox_version
 from nox.logger import logger
 from nox.manifest import WARN_PYTHONS_IGNORED, Manifest
-from nox.sessions import Result, Status
+from nox.sessions import Result, Status, _duration_str
 
 if TYPE_CHECKING:
     import types
@@ -408,14 +408,17 @@ def print_summary(
 
     # Iterate over the results and print the result for each in a
     # human-readable way.
-    logger.session_info("Ran multiple sessions:")
+    total_duration = sum(result.duration for result in results)
+    duration_str = _duration_str(total_duration, " in {time}")
+    logger.session_info(f"Ran {len(results)} sessions{duration_str}:")
     for result in results:
         name = result.session.friendly_name
         status = result.status.name.lower()
+        duration_str = _duration_str(result.duration, ", took {time}")
         if result.status is Status.SKIPPED and result.reason:
-            result.log(f"* {name}: {status} ({result.reason})")
+            result.log(f"* {name}: {status} ({result.reason}){duration_str}")
         else:
-            result.log(f"* {name}: {status}")
+            result.log(f"* {name}: {status}{duration_str}")
 
     # Return the results that were sent to this function.
     return results

pyproject.toml

@@ -43,6 +43,7 @@ dependencies = [
   "attrs>=24.1",
   "colorlog>=2.6.1,<7",
   "dependency-groups>=1.1",
+  "humanize>=4",
   "packaging>=20.9; python_version<'3.10'",
   "packaging>=21; python_version>='3.10'",
   "tomli>=1.1; python_version<'3.11'",

requirements-conda-test.txt

@@ -3,6 +3,7 @@ attrs >=23.1
 colorlog >=2.6.1,<7.0.0
 dependency-groups >=1.1
 httpx
+humanize
 jinja2
 pbs-installer>=2025.1.6
 pytest

tests/test__cli.py

@@ -34,6 +34,7 @@ def test_get_dependencies() -> None:
             "attrs",
             "colorlog",
             "dependency-groups",
+            "humanize",
             "jinja2",
             "nox",
             "packaging",

tests/test_tasks.py

@@ -773,6 +773,7 @@ def test_create_report() -> None:
                             "result": "success",
                             "result_code": 1,
                             "args": {},
+                            "duration": 0.0,
                         }
                     ],
                 },