Skip to content

Commit 43d6eb6

Browse files
authored
Add note for rename limitation (#168)
1 parent bc409e8 commit 43d6eb6

1 file changed

Lines changed: 10 additions & 0 deletions

File tree

README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,16 @@ Due to the way the tool works, it will reorder the imports multiple times.
2323
By default the tool tries to detect if a comment was moved
2424
and revert all changes to the file. This can be overwritten by using `--force`.
2525

26+
Currently, it's not possible to update aliases with a different name.
27+
In particular, these need to be updated manually:
28+
| Old typing name | New |
29+
| --------------- | --- |
30+
| `Deque` | `collections.deque` |
31+
| `DefaultDict` | `collections.defaultdict` |
32+
| `AbstractSet` | `collections.abc.Set` |
33+
| `ContextManager` | `contextlib.AbstractContextManager` |
34+
| `AsyncContextMananger` | `contextlib.AbstractAsyncContextManager` |
35+
2636

2737
## How it works
2838
1. Run [python-reorder-import][pri] to add

0 commit comments

Comments
 (0)