mirror of
https://github.com/vllm-project/vllm-ascend.git
synced 2025-10-20 13:43:53 +08:00
c7446438a9
### What this PR does / why we need it?
Follow vllm-project/vllm lint way:
https://github.com/vllm-project/vllm/blob/main/.pre-commit-config.yaml
Enable pre-commit to avoid some low level error AMAP.
This pr is one step of #1241, The purpose is make linting system more
clear and convenient, on this step, Mainly did the following things:
yapf, actionlint, ruff, typos, isort, mypy, png-lint, signoff-commit,
enforce-import-regex-instead-of-re.
TODO:
- clang-format(check for csrc with google style)
need clean code, disable for now
- pymarkdown
need clean code, disable for now
- shellcheck
need clean code, disable for now
### Does this PR introduce _any_ user-facing change?
Only developer UX change:
https://vllm-ascend--1256.org.readthedocs.build/en/1256/developer_guide/contributing.html#run-lint-locally
```
pip install -r requirements-lint.txt && pre-commit install
bash format.sh
```
### How was this patch tested?
CI passed with new added/existing test.
Co-authored-by: Yikun [yikunkero@gmail.com](mailto:yikunkero@gmail.com)
Co-authored-by: wangli
[wangli858794774@gmail.com](mailto:wangli858794774@gmail.com)
- vLLM version: v0.9.1
- vLLM main:
5358cce5ff
---------
Signed-off-by: wangli <wangli858794774@gmail.com>
105 lines
3.1 KiB
Python
105 lines
3.1 KiB
Python
#
|
|
# Copyright (c) 2025 Huawei Technologies Co., Ltd. All Rights Reserved.
|
|
# Copyright 2023 The vLLM team.
|
|
#
|
|
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
# you may not use this file except in compliance with the License.
|
|
# You may obtain a copy of the License at
|
|
#
|
|
# http://www.apache.org/licenses/LICENSE-2.0
|
|
#
|
|
# Unless required by applicable law or agreed to in writing, software
|
|
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
# See the License for the specific language governing permissions and
|
|
# limitations under the License.
|
|
# This file is a part of the vllm-ascend project.
|
|
# Adapted from https://github.com/vllm-project/vllm/tree/main/tools
|
|
#
|
|
|
|
from __future__ import annotations
|
|
|
|
import subprocess
|
|
from pathlib import Path
|
|
|
|
import regex as re
|
|
|
|
FORBIDDEN_PATTERNS = re.compile(
|
|
r'^\s*(?:import\s+re(?:$|\s|,)|from\s+re\s+import)')
|
|
ALLOWED_PATTERNS = [
|
|
re.compile(r'^\s*import\s+regex\s+as\s+re\s*$'),
|
|
re.compile(r'^\s*import\s+regex\s*$'),
|
|
]
|
|
|
|
|
|
def get_staged_python_files() -> list[str]:
|
|
try:
|
|
result = subprocess.run(
|
|
['git', 'diff', '--cached', '--name-only', '--diff-filter=AM'],
|
|
capture_output=True,
|
|
text=True,
|
|
check=True)
|
|
files = result.stdout.strip().split(
|
|
'\n') if result.stdout.strip() else []
|
|
return [f for f in files if f.endswith('.py')]
|
|
except subprocess.CalledProcessError:
|
|
return []
|
|
|
|
|
|
def is_forbidden_import(line: str) -> bool:
|
|
line = line.strip()
|
|
return bool(
|
|
FORBIDDEN_PATTERNS.match(line)
|
|
and not any(pattern.match(line) for pattern in ALLOWED_PATTERNS))
|
|
|
|
|
|
def check_file(filepath: str) -> list[tuple[int, str]]:
|
|
violations = []
|
|
try:
|
|
with open(filepath, encoding='utf-8') as f:
|
|
for line_num, line in enumerate(f, 1):
|
|
if is_forbidden_import(line):
|
|
violations.append((line_num, line.strip()))
|
|
except (OSError, UnicodeDecodeError):
|
|
pass
|
|
return violations
|
|
|
|
|
|
def main() -> int:
|
|
files = get_staged_python_files()
|
|
if not files:
|
|
return 0
|
|
|
|
total_violations = 0
|
|
|
|
for filepath in files:
|
|
if not Path(filepath).exists():
|
|
continue
|
|
|
|
if filepath == "setup.py":
|
|
continue
|
|
|
|
violations = check_file(filepath)
|
|
if violations:
|
|
print(f"\n❌ {filepath}:")
|
|
for line_num, line in violations:
|
|
print(f" Line {line_num}: {line}")
|
|
total_violations += 1
|
|
|
|
if total_violations > 0:
|
|
print(f"\n💡 Found {total_violations} violation(s).")
|
|
print("❌ Please replace 'import re' with 'import regex as re'")
|
|
print(
|
|
" Also replace 'from re import ...' with 'from regex import ...'"
|
|
) # noqa: E501
|
|
print("✅ Allowed imports:")
|
|
print(" - import regex as re")
|
|
print(" - import regex") # noqa: E501
|
|
return 1
|
|
|
|
return 0
|
|
|
|
|
|
if __name__ == "__main__":
|
|
raise SystemExit(main())
|