Improvements (#7)

* Update readme
* Add help text for --disable-committed-check
* Add debug config
* Add argument groups
* Add --keep-updates option
* Make black install optional
* Extend --full-reorder tests

Author: cdce8p

.vscode/launch.json

@@ -0,0 +1,19 @@
+{
+    // Use IntelliSense to learn about possible attributes.
+    // Hover to view descriptions of existing attributes.
+    // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+    "version": "0.2.0",
+    "configurations": [
+        {
+            "name": "python-typing-update",
+            "type": "python",
+            "request": "launch",
+            "module": "python_typing_update",
+            "args": [
+                "--disable-committed-check",
+                "${file}",
+            ],
+            "console": "internalConsole"
+        }
+    ]
+}

README.md

@@ -33,7 +33,7 @@ and revert all changes to the file. This can be overwritten by using `--force`.
    unused. If not, revert changes with `git restore`.
 4. Remove unused imports with [autoflake][autoflake].
 5. Run [isort][isort] to try to restore the previous formatting.
-6. Optional: Run [black][black]
+6. Optional: Run [black][black]. (Requires `black` to be added as `additional_dependency`)
 7. Check `git diff` for modified comments.
    If one is detected, revert changes and print file name.
    Can be overwritten with `--force`.
@@ -74,8 +74,24 @@ Use additional options from [python-reorder-imports][pri] to rewrite
 - `--py38-plus` (default): Imports from `mypy_extensions` and `typing_extensions` when possible.
 - `--py39-plus`: Rewrite [PEP 585][PEP585] typing imports. Additionally `typing.Hashable` and `typing.Sized` will also be replace by their `collections.abc` equivalents.
 
+**`--keep-updates`**  
+Keep updates even if no import was removed. Use with caution, might result in more errors.
+
 **`--black`**  
-Run `black` formatting after updates.
+Run `black` formatting after updates.  
+To use it, add `black` as `additional_dependency` in your `.pre-commit-config.yaml`.
+
+```yaml
+        additional_dependencies:
+          - black==<insert current version here!>
+```
+
+**`--disable-committed-check`**  
+Don't abort with uncommitted changes. **Don't use it in production!**
+Risk of losing uncommitted changes.
+
+
+### Different mode options
 
 **`--check`**  
 Check if files would be modified. Return with exitcode `1` or `0` if not. Useful for CI runs.
@@ -88,11 +104,17 @@ Check `git diff` before committing!
 Only update files which are likely to require extra work.
 Check `git diff` before committing!
 
+
+### Python version options
+
+**`--py38-plus`**  
+Set the minimum Python syntax version to **3.8**. This is the default.
+
 **`--py39-plus`**  
-Set the minimum Python syntax to **3.9**. (Default: **3.8**)
+Set the minimum Python syntax version to **3.9**. (Default: **3.8**)
 
 **`--py310-plus`**  
-Set the minimum Python syntax to **3.10**. (Default: **3.8**)
+Set the minimum Python syntax version to **3.10**. (Default: **3.8**)
 
 
 ## License

python_typing_update/__main__.py

@@ -29,6 +29,9 @@ async def async_main(argv: list[str] | None = None) -> int:
         description="Tool to update Python typing syntax.",
         formatter_class=CustomHelpFormatter,
     )
+    mode_options = parser.add_argument_group("select different mode")
+    py_version_options = parser.add_argument_group("python version options")
+
     parser.add_argument(
         '-v', '--verbose',
         action='count', default=0,
@@ -51,19 +54,23 @@ async def async_main(argv: list[str] | None = None) -> int:
         action='store_true',
         help="Add version_str to 'reorder-python-import' args",
     )
+    parser.add_argument(
+        '--keep-updates',
+        action='store_true',
+        help="Keep updates even if no import was removed",
+    )
     parser.add_argument(
         '--black',
         action='store_true',
         help="Run black formatting after update",
     )
     parser.add_argument(
         '--disable-committed-check',
-        action='store_true', help=argparse.SUPPRESS,
-        # Don't abort with uncommited changes
-        # Use for testing only!
+        action='store_true',
+        help="Don't abort with uncommited changes. Don't use it in production!",
     )
 
-    group1 = parser.add_mutually_exclusive_group()
+    group1 = mode_options.add_mutually_exclusive_group()
     group1.add_argument(
         '--check',
         action='store_true',
@@ -80,10 +87,11 @@ async def async_main(argv: list[str] | None = None) -> int:
         help="Only update files which are likely to require extra work",
     )
 
-    group2 = parser.add_mutually_exclusive_group()
+    group2 = py_version_options.add_mutually_exclusive_group()
     group2.add_argument(
         '--py38-plus',
         action='store_const', dest='min_version', default=(3, 8), const=(3, 8),
+        help="Default"
     )
     group2.add_argument(
         '--py39-plus',
@@ -101,6 +109,14 @@ async def async_main(argv: list[str] | None = None) -> int:
     if args.verbose > 0:
         logger.setLevel(logging.DEBUG)
 
+    if args.black is True:
+        try:
+            # pylint: disable=unused-import,import-outside-toplevel
+            import black  # noqa: F401
+        except ImportError:
+            print("Error! Black is not installed")
+            return 2
+
     return await async_run(args)
 
 

python_typing_update/main.py

@@ -74,7 +74,11 @@ async def typing_update(
             None, autoflake_partial,
             [None, '-c', filename],
         )
-        if not args.full_reorder and FileStatus.COMMENT_TYPING not in file_status:
+        if (
+            args.keep_updates is False
+            and args.full_reorder is False
+            and FileStatus.COMMENT_TYPING not in file_status
+        ):
             # -> No unused imports, revert changes
             return 2, filename
     except SystemExit:

requirements.txt

@@ -1,6 +1,5 @@
 aiofiles==0.6.0
 autoflake==1.4
-black==20.8b1
 isort==5.7.0
 pyupgrade==2.10.1
 reorder-python-imports==2.4.0

requirements_black.txt

@@ -0,0 +1 @@
+black==20.8b1

setup.py

@@ -1,21 +1,29 @@
+from __future__ import annotations
+
 from setuptools import setup
 
 from python_typing_update.const import version_str
 
-with open('requirements.txt') as fp:
-    requirements = [
-        line.strip().split(' ', 1)[0] for line in fp.read().splitlines()
-        if line.strip() != '' and not line.startswith('#')
-    ]
+
+def load_requirements_file(filename: str) -> list[str]:
+    with open(filename) as fp:
+        return [
+            line.strip().split(' ', 1)[0] for line in fp.read().splitlines()
+            if line.strip() != '' and not line.startswith('#')
+        ]
+
 
 setup(
     version=version_str,
     packages=['python_typing_update'],
-    install_requires=requirements,
     python_requires='>=3.8, <3.10',
+    install_requires=load_requirements_file('requirements.txt'),
+    extras_require={
+        'black': load_requirements_file('requirements_black.txt'),
+    },
     entry_points={
         'console_scripts': [
             'python-typing-update = python_typing_update.__main__:main',
         ],
-    }
+    },
 )

tests/fixtures/changed.py

@@ -1,8 +1,12 @@
 """Update typing syntax for Python 3.8+"""
 from typing import Any, Container, Hashable, List, Union
 
+from typing_extensions import TypeGuard, TypedDict
+
 var1: List[str]
 var2: Any
 var3: Union[int, str]
 var4: Hashable
 var5: Container
+var6: TypedDict
+var7: TypeGuard[int]

tests/fixtures/changed_fixed.py

@@ -3,8 +3,12 @@
 
 from typing import Any, Container, Hashable
 
+from typing_extensions import TypedDict, TypeGuard
+
 var1: list[str]
 var2: Any
 var3: int | str
 var4: Hashable
 var5: Container
+var6: TypedDict
+var7: TypeGuard[int]

tests/fixtures/changed_full_reorder_38.py

@@ -0,0 +1,14 @@
+"""Update typing syntax for Python 3.8+"""
+from __future__ import annotations
+
+from typing import Any, Container, Hashable, TypedDict
+
+from typing_extensions import TypeGuard
+
+var1: list[str]
+var2: Any
+var3: int | str
+var4: Hashable
+var5: Container
+var6: TypedDict
+var7: TypeGuard[int]