wehub-resource-sync
e06fe8e8c6
Self-hosted runner (benchmark) / Benchmark (aws-g5-4xlarge-cache) (push) Waiting to run
New model PR merged notification / Notify new model (push) Waiting to run
Update Transformers metadata / build_and_package (push) Waiting to run
Secret Leaks / trufflehog (push) Failing after 1s
Build documentation / build (push) Failing after 1s
Build documentation / build_other_lang (push) Failing after 0s
CodeQL Security Analysis / CodeQL Analysis (push) Failing after 0s
PR CI / pr-ci (push) Failing after 1s
Slow tests on important models (on Push - A10) / Get all modified files (push) Failing after 1s
Slow tests on important models (on Push - A10) / Model CI (push) Has been skipped
101 lines
3.5 KiB
Python
101 lines
3.5 KiB
Python
# Copyright 2023 The HuggingFace Inc. 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 script is responsible for cleaning the list of doctests by making sure the entries all exist and are in
|
|
alphabetical order.
|
|
|
|
Usage (from the root of the repo):
|
|
|
|
Check that the doctest list is properly sorted and all files exist (used in `make check-repo`):
|
|
|
|
```bash
|
|
python utils/check_doctest_list.py
|
|
```
|
|
|
|
Auto-sort the doctest list if it is not properly sorted (used in `make fix-repo`):
|
|
|
|
```bash
|
|
python utils/check_doctest_list.py --fix_and_overwrite
|
|
```
|
|
"""
|
|
|
|
import argparse
|
|
import os
|
|
|
|
|
|
CHECKER_CONFIG = {
|
|
"name": "doctest_list",
|
|
"label": "Doctest list",
|
|
# Over-approximation: the checker validates that paths in .txt list files exist and are
|
|
# sorted. The broad globs ensure cache invalidation when source files are added/removed.
|
|
"cache_globs": [
|
|
"utils/not_doctested.txt",
|
|
"utils/slow_documentation_tests.txt",
|
|
"src/transformers/**/*.py",
|
|
"docs/**/*.md",
|
|
],
|
|
"check_args": [],
|
|
"fix_args": ["--fix_and_overwrite"],
|
|
}
|
|
|
|
# All paths are set with the intent you should run this script from the root of the repo with the command
|
|
# python utils/check_doctest_list.py
|
|
REPO_PATH = "."
|
|
DOCTEST_FILE_PATHS = ["not_doctested.txt", "slow_documentation_tests.txt"]
|
|
|
|
|
|
def clean_doctest_list(doctest_file: str, overwrite: bool = False):
|
|
"""
|
|
Cleans the doctest in a given file.
|
|
|
|
Args:
|
|
doctest_file (`str`):
|
|
The path to the doctest file to check or clean.
|
|
overwrite (`bool`, *optional*, defaults to `False`):
|
|
Whether or not to fix problems. If `False`, will error when the file is not clean.
|
|
"""
|
|
non_existent_paths = []
|
|
all_paths = []
|
|
with open(doctest_file, "r", encoding="utf-8") as f:
|
|
for line in f:
|
|
line = line.strip().split(" ")[0]
|
|
path = os.path.join(REPO_PATH, line)
|
|
if not (os.path.isfile(path) or os.path.isdir(path)):
|
|
non_existent_paths.append(line)
|
|
all_paths.append(line)
|
|
|
|
if len(non_existent_paths) > 0:
|
|
non_existent_paths = "\n".join([f"- {f}" for f in non_existent_paths])
|
|
raise ValueError(f"`{doctest_file}` contains non-existent paths:\n{non_existent_paths}")
|
|
|
|
sorted_paths = sorted(all_paths)
|
|
if all_paths != sorted_paths:
|
|
if not overwrite:
|
|
raise ValueError(
|
|
f"Files in `{doctest_file}` are not in alphabetical order, run `make fix-repo` to fix "
|
|
"this automatically."
|
|
)
|
|
with open(doctest_file, "w", encoding="utf-8") as f:
|
|
f.write("\n".join(sorted_paths) + "\n")
|
|
|
|
|
|
if __name__ == "__main__":
|
|
parser = argparse.ArgumentParser()
|
|
parser.add_argument("--fix_and_overwrite", action="store_true", help="Whether to fix inconsistencies.")
|
|
args = parser.parse_args()
|
|
|
|
for doctest_file in DOCTEST_FILE_PATHS:
|
|
doctest_file = os.path.join(REPO_PATH, "utils", doctest_file)
|
|
clean_doctest_list(doctest_file, args.fix_and_overwrite)
|