frostming / fix-future-annotations Goto Github PK

View Code? Open in Web Editor NEW

35.0 2.0 3.0 39 KB

A CLI and pre-commit hook to fix future annotations

License: MIT License

Python 100.00%

pre-commit pre-commit-hook python typing

fix-future-annotations's Introduction

fix-future-annotations

A CLI and pre-commit hook to upgrade the typing annotations syntax to PEP 585 and PEP 604.

Upgrade Details

PEP 585 – Type Hinting Generics In Standard Collections

Old	New
typing.Dict[str, int] List[str]	dict[str, int] list[str]

PEP 604 – Allow writing union types as `X | Y`

Old	New
typing.Union[str, int] Optional[str]	str \| int str \| None

PEP 563 – Postponed Evaluation of Annotations

Old	New
def create() -> "Foo": pass	def create() -> Foo: pass

Import aliases handling

Old	New
import typing as t from typing import Tuple as MyTuple def foo() -> MyTuple[str, t.Optional[int]]: pass	from __future__ import annotations import typing as t def foo() -> tuple[str, int \| None]: pass

Full example

Old	New
from typing import Union, Dict, Optional, Tuple # non-annotation usage will be preserved MyType = Union[str, int] def foo() -> Tuple[Dict[str, int], Optional[str]]: ...	from __future__ import annotations from typing import Union # non-annotation usage will be preserved MyType = Union[str, int] def foo() -> tuple[dict[str, int], str \| None]: ...

Old

New

from typing import Union, Dict, Optional, Tuple

# non-annotation usage will be preserved
MyType = Union[str, int]


def foo() -> Tuple[Dict[str, int], Optional[str]]:
    ...

from __future__ import annotations

from typing import Union

# non-annotation usage will be preserved
MyType = Union[str, int]


def foo() -> tuple[dict[str, int], str | None]:
    ...

Unused import names will be removed, and if from __future__ import annotations is not found in the script, it will be automatically added if the new syntax is being used.

Use as a command line tool

python3 -m pip install -U fix-future-annotations

fix-future-annotations my_script.py

Use as pre-commit hook

Add the following to your .pre-commit-config.yaml:

repos:
  - repo: https://github.com/frostming/fix-future-annotations
    rev: 0.5.0  # a released version tag
    hooks:
      - id: fix-future-annotations

Configurations

fix-future-annotations can be configured via pyproject.toml. Here is an example:

[tool.fix_future_annotations]
exclude_files = [  # regex patterns to exclude files
    'tests/.*',
    'docs/.*',
]

exclude_lines = [  # regex patterns to exclude lines
    '# ffa: ignore',   # if a line ends with this comment, the whole *block* will be excluded
    'class .+\(BaseModel\):'  # classes that inherit from `BaseModel` will be excluded
]

License

This work is distributed under MIT license.

fix-future-annotations's People

Contributors

Stargazers

Watchers

Forkers

boholder pierre-sassoulas cache-missing

fix-future-annotations's Issues

Thanks!

I wish I had seen this one month ago, before doing that with a handful of regular expressions 🤣
And I'll use it right now on another project! So thanks, lots of time spared thanks to this tool 🙂

[0.5.0 misuse] Only exclude 'class .+\(BaseModel\):' is not enough for pydantic proj.

The "bug" reproducting branch:
https://github.com/boholder/puntgun/commits/test-fix-tool

Env( boholder/puntgun@7ba9738 ):

pyproject.toml:

[tool.fix_future_annotations]
exclude_lines = [
    'class .+\(BaseModel\):'
]

Run the tool (with pre-commit) with the configuration above, then revert the data.py file, unit tests can pass as usual.
Ok, I then tried one by one against the changes (made to the data.py file by this tool) and found that only the insert of from __future__ import annotations statement will actually triggered the error.

Without this line (tests pass):
boholder/puntgun@1e85bb9

With this line (tests fail):
boholder/puntgun@005e180

(puntgun-3.10) \code\python\puntgun>pdm test
ImportError while loading conftest 'E:\code\python\puntgun\tests\conftest.py'.
tests\conftest.py:9: in <module>
    from puntgun.rules.config_parser import ConfigParser
puntgun\rules\config_parser.py:93: in <module>
    import_rule_classes()
puntgun\rules\config_parser.py:32: in import_rule_classes
    importlib.import_module(f"{base_module_name}.{module_name}")
puntgun\rules\user\action_rules.py:3: in <module>
    from puntgun.client import NeedClientMixin
puntgun\client.py:15: in <module>
    from puntgun.rules.data import Media, Place, Poll, Tweet, User
puntgun\rules\data.py:217: in <module>
    class Tweet(BaseModel):
puntgun\rules\data.py:228: in Tweet
    author: User | None = User()
pydantic\main.py:342: in pydantic.main.BaseModel.__init__
    ???
E   pydantic.error_wrappers.ValidationError: 1 validation error for User
E   pinned_tweet
E     field required (type=value_error.missing)

I think it would be better to change the logic of exclude class configuration to "exclude the file where the class is located"? Although there is already a configuration to exclude files, but the configuration to exclude special classes is more flexible than to exclude files?

It up to you, dear maintainer, thank you very much for your work and quick response to the needs. ♥

Will there be an option to traverse a dir？

Have it considered adding an option like "-r" to fix every file in the specified directory？