Add deprecation messaging for `fix-encoding-pragma`
This commit is contained in:
parent
c8715b78af
commit
cef973f323
|
@ -145,7 +145,7 @@
|
||||||
language: python
|
language: python
|
||||||
types: [text]
|
types: [text]
|
||||||
- id: fix-encoding-pragma
|
- id: fix-encoding-pragma
|
||||||
name: fix python encoding pragma
|
name: fix python encoding pragma (deprecated)
|
||||||
description: 'adds # -*- coding: utf-8 -*- to the top of python files.'
|
description: 'adds # -*- coding: utf-8 -*- to the top of python files.'
|
||||||
language: python
|
language: python
|
||||||
entry: fix-encoding-pragma
|
entry: fix-encoding-pragma
|
||||||
|
|
|
@ -127,6 +127,9 @@ The following arguments are available:
|
||||||
removes UTF-8 byte order marker
|
removes UTF-8 byte order marker
|
||||||
|
|
||||||
#### `fix-encoding-pragma`
|
#### `fix-encoding-pragma`
|
||||||
|
|
||||||
|
_Deprecated since py2 is EOL - use [pyupgrade](https://github.com/asottile/pyupgrade) instead._
|
||||||
|
|
||||||
Add `# -*- coding: utf-8 -*-` to the top of python files.
|
Add `# -*- coding: utf-8 -*-` to the top of python files.
|
||||||
- To remove the coding pragma pass `--remove` (useful in a python3-only codebase)
|
- To remove the coding pragma pass `--remove` (useful in a python3-only codebase)
|
||||||
|
|
||||||
|
|
|
@ -1,6 +1,7 @@
|
||||||
from __future__ import annotations
|
from __future__ import annotations
|
||||||
|
|
||||||
import argparse
|
import argparse
|
||||||
|
import sys
|
||||||
from typing import IO
|
from typing import IO
|
||||||
from typing import NamedTuple
|
from typing import NamedTuple
|
||||||
from typing import Sequence
|
from typing import Sequence
|
||||||
|
@ -107,6 +108,13 @@ def _normalize_pragma(pragma: str) -> bytes:
|
||||||
|
|
||||||
|
|
||||||
def main(argv: Sequence[str] | None = None) -> int:
|
def main(argv: Sequence[str] | None = None) -> int:
|
||||||
|
print(
|
||||||
|
'warning: this hook is deprecated and will be removed in a future '
|
||||||
|
'release because py2 is EOL. instead, use '
|
||||||
|
'https://github.com/asottile/pyupgrade',
|
||||||
|
file=sys.stderr,
|
||||||
|
)
|
||||||
|
|
||||||
parser = argparse.ArgumentParser(
|
parser = argparse.ArgumentParser(
|
||||||
'Fixes the encoding pragma of python files',
|
'Fixes the encoding pragma of python files',
|
||||||
)
|
)
|
||||||
|
|
Loading…
Reference in New Issue