Use aware datetimes to represent UTC (#3728)

Avoids a Python 3.12 deprecation warning.

Subtle difference: previously, timestamps in diff filenames had the
`+0000` separated from the timestamp by space. With this, the space is
there no more, and there is a colon, as in `+00:00`.

diff --git a/CHANGES.md b/CHANGES.md
index fb3dea8c348fd54677f543a07ceb4d51cb0eb1e9..658faad3a78bba23fe62346f66336dd9f88b3c8f 100644 (file)
--- a/CHANGES.md
+++ b/CHANGES.md
@@ -42,6 +42,8 @@
 
 <!-- Changes to Black's terminal output and error messages -->
 
 
 <!-- Changes to Black's terminal output and error messages -->
 

+- Use aware UTC datetimes internally, avoids deprecation warning on Python 3.12 (#3728)
+

 ### _Blackd_
 
 <!-- Changes to blackd -->
 ### _Blackd_
 
 <!-- Changes to blackd -->

diff --git a/docs/usage_and_configuration/the_basics.md b/docs/usage_and_configuration/the_basics.md
index 48619c6bbe8dfd51da575fcce5b46383b3a11df5..6f3a3cff30c58f6ccbdb6c3df29a61ef20e34256 100644 (file)
--- a/docs/usage_and_configuration/the_basics.md
+++ b/docs/usage_and_configuration/the_basics.md
@@ -164,8 +164,8 @@ If you'd like colored diffs, you can enable them with `--color`.
 
 ```console
 $ black test.py --diff
 
 ```console
 $ black test.py --diff

---- test.py     2021-03-08 22:23:40.848954 +0000
-+++ test.py     2021-03-08 22:23:47.126319 +0000
+--- test.py     2021-03-08 22:23:40.848954+00:00
++++ test.py     2021-03-08 22:23:47.126319+00:00

 @@ -1 +1 @@
 -print ( 'hello, world' )
 +print("hello, world")
 @@ -1 +1 @@
 -print ( 'hello, world' )
 +print("hello, world")

diff --git a/src/black/__init__.py b/src/black/__init__.py
index 8a759aa493ae2e0e045d52549d8071b7f0677547..dbcb559f09d5d647b603c1cbc4099443a63de2f5 100644 (file)
--- a/src/black/__init__.py
+++ b/src/black/__init__.py
@@ -7,7 +7,7 @@ import tokenize
 import traceback
 from contextlib import contextmanager
 from dataclasses import replace
 import traceback
 from contextlib import contextmanager
 from dataclasses import replace

-from datetime import datetime
+from datetime import datetime, timezone

 from enum import Enum
 from json.decoder import JSONDecodeError
 from pathlib import Path
 from enum import Enum
 from json.decoder import JSONDecodeError
 from pathlib import Path


@@ -807,7 +807,7 @@ def format_file_in_place(
     elif src.suffix == ".ipynb":
         mode = replace(mode, is_ipynb=True)
 
     elif src.suffix == ".ipynb":
         mode = replace(mode, is_ipynb=True)
 

-    then = datetime.utcfromtimestamp(src.stat().st_mtime)
+    then = datetime.fromtimestamp(src.stat().st_mtime, timezone.utc)

     header = b""
     with open(src, "rb") as buf:
         if mode.skip_source_first_line:
     header = b""
     with open(src, "rb") as buf:
         if mode.skip_source_first_line:


@@ -828,9 +828,9 @@ def format_file_in_place(
         with open(src, "w", encoding=encoding, newline=newline) as f:
             f.write(dst_contents)
     elif write_back in (WriteBack.DIFF, WriteBack.COLOR_DIFF):
         with open(src, "w", encoding=encoding, newline=newline) as f:
             f.write(dst_contents)
     elif write_back in (WriteBack.DIFF, WriteBack.COLOR_DIFF):

-        now = datetime.utcnow()
-        src_name = f"{src}\t{then} +0000"
-        dst_name = f"{src}\t{now} +0000"
+        now = datetime.now(timezone.utc)
+        src_name = f"{src}\t{then}"
+        dst_name = f"{src}\t{now}"

         if mode.is_ipynb:
             diff_contents = ipynb_diff(src_contents, dst_contents, src_name, dst_name)
         else:
         if mode.is_ipynb:
             diff_contents = ipynb_diff(src_contents, dst_contents, src_name, dst_name)
         else:


@@ -868,7 +868,7 @@ def format_stdin_to_stdout(
     write a diff to stdout. The `mode` argument is passed to
     :func:`format_file_contents`.
     """
     write a diff to stdout. The `mode` argument is passed to
     :func:`format_file_contents`.
     """

-    then = datetime.utcnow()
+    then = datetime.now(timezone.utc)

 
     if content is None:
         src, encoding, newline = decode_bytes(sys.stdin.buffer.read())
 
     if content is None:
         src, encoding, newline = decode_bytes(sys.stdin.buffer.read())


@@ -893,9 +893,9 @@ def format_stdin_to_stdout(
                 dst += "\n"
             f.write(dst)
         elif write_back in (WriteBack.DIFF, WriteBack.COLOR_DIFF):
                 dst += "\n"
             f.write(dst)
         elif write_back in (WriteBack.DIFF, WriteBack.COLOR_DIFF):

-            now = datetime.utcnow()
-            src_name = f"STDIN\t{then} +0000"
-            dst_name = f"STDOUT\t{now} +0000"
+            now = datetime.now(timezone.utc)
+            src_name = f"STDIN\t{then}"
+            dst_name = f"STDOUT\t{now}"

             d = diff(src, dst, src_name, dst_name)
             if write_back == WriteBack.COLOR_DIFF:
                 d = color_diff(d)
             d = diff(src, dst, src_name, dst_name)
             if write_back == WriteBack.COLOR_DIFF:
                 d = color_diff(d)

diff --git a/src/blackd/__init__.py b/src/blackd/__init__.py
index d331ad000bc94e808e2d0ad23acd121f6eb505e3..c1b69feed634ffed06581c784cf5295b4b69021a 100644 (file)
--- a/src/blackd/__init__.py
+++ b/src/blackd/__init__.py
@@ -1,7 +1,7 @@
 import asyncio
 import logging
 from concurrent.futures import Executor, ProcessPoolExecutor
 import asyncio
 import logging
 from concurrent.futures import Executor, ProcessPoolExecutor

-from datetime import datetime
+from datetime import datetime, timezone

 from functools import partial
 from multiprocessing import freeze_support
 from typing import Set, Tuple
 from functools import partial
 from multiprocessing import freeze_support
 from typing import Set, Tuple


@@ -138,7 +138,7 @@ async def handle(request: web.Request, executor: Executor) -> web.Response:
         req_bytes = await request.content.read()
         charset = request.charset if request.charset is not None else "utf8"
         req_str = req_bytes.decode(charset)
         req_bytes = await request.content.read()
         charset = request.charset if request.charset is not None else "utf8"
         req_str = req_bytes.decode(charset)

-        then = datetime.utcnow()
+        then = datetime.now(timezone.utc)

 
         header = ""
         if skip_source_first_line:
 
         header = ""
         if skip_source_first_line:


@@ -165,9 +165,9 @@ async def handle(request: web.Request, executor: Executor) -> web.Response:
         # Only output the diff in the HTTP response
         only_diff = bool(request.headers.get(DIFF_HEADER, False))
         if only_diff:
         # Only output the diff in the HTTP response
         only_diff = bool(request.headers.get(DIFF_HEADER, False))
         if only_diff:

-            now = datetime.utcnow()
-            src_name = f"In\t{then} +0000"
-            dst_name = f"Out\t{now} +0000"
+            now = datetime.now(timezone.utc)
+            src_name = f"In\t{then}"
+            dst_name = f"Out\t{now}"

             loop = asyncio.get_event_loop()
             formatted_str = await loop.run_in_executor(
                 executor,
             loop = asyncio.get_event_loop()
             formatted_str = await loop.run_in_executor(
                 executor,

diff --git a/tests/test_black.py b/tests/test_black.py
index 42b0161d1569bdc5f6174d6ffe71be1b015df1ed..5f2e6f5b14c55056ed14e5535a6d9d646112696a 100644 (file)
--- a/tests/test_black.py
+++ b/tests/test_black.py
@@ -207,8 +207,8 @@ class BlackTestCase(BlackBaseTestCase):
 
     def test_piping_diff(self) -> None:
         diff_header = re.compile(
 
     def test_piping_diff(self) -> None:
         diff_header = re.compile(

-            r"(STDIN|STDOUT)\t\d\d\d\d-\d\d-\d\d \d\d:\d\d:\d\d\.\d\d\d\d\d\d "
-            r"\+\d\d\d\d"
+            r"(STDIN|STDOUT)\t\d\d\d\d-\d\d-\d\d \d\d:\d\d:\d\d\.\d\d\d\d\d\d"
+            r"\+\d\d:\d\d"

         )
         source, _ = read_data("simple_cases", "expression.py")
         expected, _ = read_data("simple_cases", "expression.diff")
         )
         source, _ = read_data("simple_cases", "expression.py")
         expected, _ = read_data("simple_cases", "expression.diff")


@@ -300,7 +300,7 @@ class BlackTestCase(BlackBaseTestCase):
         tmp_file = Path(black.dump_to_file(source))
         diff_header = re.compile(
             rf"{re.escape(str(tmp_file))}\t\d\d\d\d-\d\d-\d\d "
         tmp_file = Path(black.dump_to_file(source))
         diff_header = re.compile(
             rf"{re.escape(str(tmp_file))}\t\d\d\d\d-\d\d-\d\d "

-            r"\d\d:\d\d:\d\d\.\d\d\d\d\d\d \+\d\d\d\d"
+            r"\d\d:\d\d:\d\d\.\d\d\d\d\d\d\+\d\d:\d\d"

         )
         try:
             result = BlackRunner().invoke(
         )
         try:
             result = BlackRunner().invoke(


@@ -411,7 +411,7 @@ class BlackTestCase(BlackBaseTestCase):
         tmp_file = Path(black.dump_to_file(source))
         diff_header = re.compile(
             rf"{re.escape(str(tmp_file))}\t\d\d\d\d-\d\d-\d\d "
         tmp_file = Path(black.dump_to_file(source))
         diff_header = re.compile(
             rf"{re.escape(str(tmp_file))}\t\d\d\d\d-\d\d-\d\d "

-            r"\d\d:\d\d:\d\d\.\d\d\d\d\d\d \+\d\d\d\d"
+            r"\d\d:\d\d:\d\d\.\d\d\d\d\d\d\+\d\d:\d\d"

         )
         try:
             result = BlackRunner().invoke(
         )
         try:
             result = BlackRunner().invoke(


@@ -1750,7 +1750,7 @@ class BlackTestCase(BlackBaseTestCase):
         tmp_file = Path(black.dump_to_file(source, ensure_final_newline=False))
         diff_header = re.compile(
             rf"{re.escape(str(tmp_file))}\t\d\d\d\d-\d\d-\d\d "
         tmp_file = Path(black.dump_to_file(source, ensure_final_newline=False))
         diff_header = re.compile(
             rf"{re.escape(str(tmp_file))}\t\d\d\d\d-\d\d-\d\d "

-            r"\d\d:\d\d:\d\d\.\d\d\d\d\d\d \+\d\d\d\d"
+            r"\d\d:\d\d:\d\d\.\d\d\d\d\d\d\+\d\d:\d\d"

         )
         try:
             result = BlackRunner().invoke(black.main, ["--diff", str(tmp_file)])
         )
         try:
             result = BlackRunner().invoke(black.main, ["--diff", str(tmp_file)])

diff --git a/tests/test_blackd.py b/tests/test_blackd.py
index 5b6461f76859e69ddce3e5091a14ccc6cfc9c989..325bd7dd5aaf6f5a4483c0b53375a22e78028dad 100644 (file)
--- a/tests/test_blackd.py
+++ b/tests/test_blackd.py
@@ -114,7 +114,7 @@ class BlackDTestCase(AioHTTPTestCase):  # type: ignore[misc]
     @unittest_run_loop
     async def test_blackd_diff(self) -> None:
         diff_header = re.compile(
     @unittest_run_loop
     async def test_blackd_diff(self) -> None:
         diff_header = re.compile(

-            r"(In|Out)\t\d\d\d\d-\d\d-\d\d \d\d:\d\d:\d\d\.\d\d\d\d\d\d \+\d\d\d\d"
+            r"(In|Out)\t\d\d\d\d-\d\d-\d\d \d\d:\d\d:\d\d\.\d\d\d\d\d\d\+\d\d:\d\d"

         )
 
         source, _ = read_data("miscellaneous", "blackd_diff")
         )
 
         source, _ = read_data("miscellaneous", "blackd_diff")