### What this PR does / why we need it?
This PR introduces several upstream `vllm`-aligned lint hooks into
`vllm-ascend` and makes them part of the actual `pre-commit` flow.
Main changes in this PR:
- add `check-boolean-context-manager` to catch boolean expressions in
`with` statements
- add `check-forbidden-imports` to forbid direct `re` imports and
disallowed direct `triton` imports
- enable shell script linting through `tools/shellcheck.sh`
- add root `.clang-format` aligned with upstream `vllm`, enable
`clang-format` in `pre-commit`, temporarily **exclude all `csrc/**`**
from `clang-format` to avoid bringing a large native code reformat into
this PR
This PR focuses on landing the smaller and immediately useful lint
alignment first, without mixing in the larger requirements-management
migration.
### Does this PR introduce _any_ user-facing change?
No.
This PR only updates repository lint configuration, static checks, and
internal import/style enforcement. It does not change runtime behavior
or public interfaces.
### How was this patch tested?
Tested locally in the project virtual environment.
Commands used:
```bash
bash format.sh
```
Verified checks passed:
``` bash
ruff check...............................................................Passed
ruff format..............................................................Passed
codespell................................................................Passed
typos....................................................................Passed
clang-format.............................................................Passed
Lint GitHub Actions workflow files.......................................Passed
Lint shell scripts.......................................................Passed
Lint PNG exports from excalidraw.........................................Passed
Check for spaces in all filenames........................................Passed
Enforce __init__.py in Python packages...................................Passed
Check for forbidden imports..............................................Passed
Check for boolean ops in with-statements.................................Passed
Suggestion...............................................................Passed
- hook id: suggestion
- duration: 0s
To bypass pre-commit hooks, add --no-verify to git commit.
```
**note:**
clang-format is enabled but currently excludes all csrc/**
- vLLM version: v0.17.0
- vLLM main:
8b6325758c
---------
Signed-off-by: MrZ20 <2609716663@qq.com>
64 lines
1.9 KiB
Python
64 lines
1.9 KiB
Python
#
|
|
# Copyright (c) 2025 Huawei Technologies Co., Ltd. All Rights Reserved.
|
|
#
|
|
# 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.
|
|
#
|
|
|
|
import os
|
|
import socket
|
|
|
|
import regex as re
|
|
from vllm.logger import logger
|
|
|
|
|
|
def find_free_port():
|
|
"""
|
|
Finds a free port on the local machine.
|
|
|
|
Returns:
|
|
- A free port number.
|
|
"""
|
|
with socket.socket(socket.AF_INET, socket.SOCK_STREAM) as s:
|
|
s.bind(("", 0))
|
|
return s.getsockname()[1]
|
|
|
|
|
|
def is_valid_path_prefix(path_prefix):
|
|
"""
|
|
Checks if the provided path prefix is valid.
|
|
|
|
Parameters:
|
|
- path_prefix: The path prefix to validate.
|
|
|
|
Returns:
|
|
- True if the path prefix is valid, otherwise False.
|
|
"""
|
|
if not path_prefix:
|
|
return False
|
|
|
|
if re.search(r'[<>:"|?*]', path_prefix):
|
|
logger.warning(f"The path prefix {path_prefix} contains illegal characters.")
|
|
return False
|
|
|
|
if path_prefix.startswith("/") or path_prefix.startswith("\\"):
|
|
if not os.path.exists(os.path.dirname(path_prefix)):
|
|
logger.warning(f"The directory for the path prefix {os.path.dirname(path_prefix)} does not exist.")
|
|
return False
|
|
else:
|
|
if not os.path.exists(os.path.dirname(os.path.abspath(path_prefix))):
|
|
logger.warning(
|
|
f"The directory for the path prefix {os.path.dirname(os.path.abspath(path_prefix))} does not exist."
|
|
)
|
|
return False
|
|
return True
|