Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

rewrite to datetime.UTC #764

Merged
merged 1 commit into from Dec 2, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
13 changes: 13 additions & 0 deletions README.md
Expand Up @@ -694,3 +694,16 @@ Availability:
-def f(x: 'queue.Queue[int]') -> C:
+def f(x: queue.Queue[int]) -> C:
```


### use `datetime.UTC` alias

Availability:
- `--py311-plus` is passed on the commandline.

```diff
import datetime

-datetime.timezone.utc
+datetime.UTC
```
35 changes: 35 additions & 0 deletions pyupgrade/_plugins/datetime_utc_alias.py
@@ -0,0 +1,35 @@
from __future__ import annotations

import ast
import functools
from typing import Iterable

from tokenize_rt import Offset

from pyupgrade._ast_helpers import ast_to_offset
from pyupgrade._data import register
from pyupgrade._data import State
from pyupgrade._data import TokenFunc
from pyupgrade._token_helpers import replace_name


@register(ast.Attribute)
def visit_Attribute(
state: State,
node: ast.Attribute,
parent: ast.AST,
) -> Iterable[tuple[Offset, TokenFunc]]:
if (
state.settings.min_version >= (3, 11) and
node.attr == 'utc' and
isinstance(node.value, ast.Attribute) and
node.value.attr == 'timezone' and
isinstance(node.value.value, ast.Name) and
node.value.value.id == 'datetime'
):
func = functools.partial(
replace_name,
name='utc',
new='datetime.UTC',
)
yield ast_to_offset(node), func
41 changes: 41 additions & 0 deletions tests/features/datetime_utc_alias_test.py
@@ -0,0 +1,41 @@
from __future__ import annotations

import pytest

from pyupgrade._data import Settings
from pyupgrade._main import _fix_plugins


@pytest.mark.parametrize(
('s',),
(
pytest.param(
'import datetime\n'
'print(datetime.timezone(-1))',

id='not rewriting timezone object to alias',
),
),
)
def test_fix_datetime_utc_alias_noop(s):
assert _fix_plugins(s, settings=Settings(min_version=(3,))) == s
assert _fix_plugins(s, settings=Settings(min_version=(3, 11))) == s


@pytest.mark.parametrize(
('s', 'expected'),
(
pytest.param(
'import datetime\n'
'print(datetime.timezone.utc)',

'import datetime\n'
'print(datetime.UTC)',

id='rewriting to alias',
),
),
)
def test_fix_datetime_utc_alias(s, expected):
assert _fix_plugins(s, settings=Settings(min_version=(3,))) == s
assert _fix_plugins(s, settings=Settings(min_version=(3, 11))) == expected