mirror of
https://github.com/volcengine/verl.git
synced 2025-10-20 13:43:50 +08:00
b00f77d855
> [!WARNING]
> We are [immigrating to `ruff` as the linter and formatter and
`pre-commit` as the managing
tool](https://github.com/volcengine/verl/pull/1010).
>
> If your branch is based on a previous commit using `yapf` and
`pylint`, simply merging might trigger overwhelming linting errors,
while **you are only expected to resolve ones in the files related to
your PR**.
>
> To resolve this issue, please try the following workaround to only
include the files you **really changed** in the PR:
>
> 1. In your branch, fix linting and format with `ruff`: `ruff check
--fix && ruff-format`
> 2. Squash into a single commit in a new branch: `git reset --soft
$(git merge-base main HEAD) && git add -A && git commit -m "feat: ..."`
> 3. Merge with the latest main: `git merge origin/main`
> 4. Force push to your branch: `git push --force`
We add the reminder above to the documentation to tell contributors how
to avoid overwhelming linting errors.
### Motivation
According to dicussion in #896, this PR immigrates from yapf & pylint to
ruff based on pre-commit, which allows unified version control and
automatic hook on committing.
### Summary
The `pre-commit` hook and CI
- checks staged / committed files in commits / PR's
- checks all files each month (This should fail before we fix all the
files by the ruff standard)
### Explanation for the Failing CI Workflow `pre-commit`
For now, we only apply `ruff format` and `ruff check --fix` **without
resolving all the errors**, since there are too many errors to resolve,
which causes the CI workflow `pre-commit` fails.
For resolving the remaining errors, we leave to future commits.
Specifically, the `pre-commit` hook and CI will require every commit to
fix its related files with `ruff`, which will fix all the files
incrementally.
### Reviewing Suggestion
The commit
3d93f51ba8
is huge since we apply `ruff` to all the files. To review the main
changes, please check the commits before and after it.
45 lines
1.8 KiB
Python
45 lines
1.8 KiB
Python
# Copyright 2024 Bytedance Ltd. and/or its affiliates
|
|
#
|
|
# 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.
|
|
|
|
license_head_bytedance = "Copyright 2024 Bytedance Ltd. and/or its affiliates"
|
|
license_head_bytedance_25 = "Copyright 2025 Bytedance Ltd. and/or its affiliates"
|
|
# Add custom license headers below
|
|
license_head_prime = "Copyright 2024 PRIME team and/or its affiliates"
|
|
license_head_individual = "Copyright 2025 Individual Contributor:"
|
|
license_headers = [license_head_bytedance, license_head_bytedance_25, license_head_prime, license_head_individual]
|
|
|
|
from argparse import ArgumentParser
|
|
from pathlib import Path
|
|
|
|
if __name__ == "__main__":
|
|
parser = ArgumentParser()
|
|
parser.add_argument("--directory", "-d", required=True, type=str)
|
|
args = parser.parse_args()
|
|
directory_in_str = args.directory
|
|
|
|
pathlist = Path(directory_in_str).glob("**/*.py")
|
|
for path in pathlist:
|
|
# because path is object not string
|
|
path_in_str = str(path.absolute())
|
|
print(path_in_str)
|
|
with open(path_in_str, encoding="utf-8") as f:
|
|
file_content = f.read()
|
|
|
|
has_license = False
|
|
for lh in license_headers:
|
|
if lh in file_content:
|
|
has_license = True
|
|
break
|
|
assert has_license, f"file {path_in_str} does not contain license"
|