Skip to content

Commit

Permalink
Add deprecation messaging for fix-encoding-pragma
Browse files Browse the repository at this point in the history
  • Loading branch information
mxr authored and asottile committed Apr 6, 2024
1 parent c8715b7 commit cef973f
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 1 deletion.
2 changes: 1 addition & 1 deletion .pre-commit-hooks.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -145,7 +145,7 @@
language: python
types: [text]
- 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.'
language: python
entry: fix-encoding-pragma
Expand Down
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -127,6 +127,9 @@ The following arguments are available:
removes UTF-8 byte order marker

#### `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.
- To remove the coding pragma pass `--remove` (useful in a python3-only codebase)

Expand Down
8 changes: 8 additions & 0 deletions pre_commit_hooks/fix_encoding_pragma.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
from __future__ import annotations

import argparse
import sys
from typing import IO
from typing import NamedTuple
from typing import Sequence
Expand Down Expand Up @@ -107,6 +108,13 @@ def _normalize_pragma(pragma: str) -> bytes:


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(
'Fixes the encoding pragma of python files',
)
Expand Down

0 comments on commit cef973f

Please sign in to comment.