Merge pull request #865 from ericdasse-stonal/fix-warning-python-3.14

Fix DeprecationWarning

Author: fizyk

newsfragments/865.misc.rst

@@ -0,0 +1,12 @@
+Fix DeprecationWarning: datetime.datetime.utcnow() is deprecated and scheduled for removal in a future version.
+
+`datetime.datetime.utcnow` has been deprecated by Python and will soon be removed by Python 3.14 (see warning text below)
+
+The following warning used to pop up everytime someone with a recent version of Python (3.12+) uses this plugin
+
+.. code-block::
+
+    .venv/lib/python3.12/site-packages/pytest_postgresql/retry.py:22: DeprecationWarning: datetime.datetime.utcnow() is deprecated and scheduled for removal in a future version. Use timezone-aware objects to represent datetimes in UTC: datetime.datetime.now(datetime.UTC).
+        time: datetime = datetime.utcnow()
+
+    -- Docs: https://docs.pytest.org/en/stable/how-to/capture-warnings.html

pytest_postgresql/retry.py

@@ -1,14 +1,17 @@
 """Small retry callable in case of specific error occurred."""
 
-from datetime import datetime, timedelta
+import datetime
+import sys
 from time import sleep
 from typing import Callable, Type, TypeVar
 
 T = TypeVar("T")
 
 
 def retry(
-    func: Callable[[], T], timeout: int = 60, possible_exception: Type[Exception] = Exception
+    func: Callable[[], T],
+    timeout: int = 60,
+    possible_exception: Type[Exception] = Exception,
 ) -> T:
     """Attempt to retry the function for timeout time.
 
@@ -19,15 +22,27 @@ def retry(
     ... ::
         FATAL:  the database system is starting up
     """
-    time: datetime = datetime.utcnow()
-    timeout_diff: timedelta = timedelta(seconds=timeout)
+    time: datetime.datetime = get_current_datetime()
+    timeout_diff: datetime.timedelta = datetime.timedelta(seconds=timeout)
     i = 0
     while True:
         i += 1
         try:
             res = func()
             return res
         except possible_exception as e:
-            if time + timeout_diff < datetime.utcnow():
+            if time + timeout_diff < datetime.datetime.utcnow():
                 raise TimeoutError(f"Failed after {i} attempts") from e
             sleep(1)
+
+
+def get_current_datetime() -> datetime.datetime:
+    """Get the current datetime."""
+    # To ensure the current datetime retrieval is adjusted with the latest
+    # versions of Python while ensuring retro-compatibility with
+    # Python 3.8, 3.9 and 3.10, we check what version of Python is
+    # being used before deciding how to operate
+    if sys.version_info.major == 3 and sys.version_info.minor > 10:
+        return datetime.datetime.now(datetime.UTC)
+
+    return datetime.datetime.utcnow()