mirror of https://github.com/vllm-project/vllm.git
159 lines
5.1 KiB
Python
159 lines
5.1 KiB
Python
# SPDX-License-Identifier: Apache-2.0
|
|
# SPDX-FileCopyrightText: Copyright contributors to the vLLM project
|
|
"""
|
|
Ensures all fields in a config dataclass have default values
|
|
and that each field has a docstring.
|
|
"""
|
|
|
|
import ast
|
|
import inspect
|
|
import sys
|
|
|
|
|
|
def get_attr_docs(cls_node: ast.ClassDef) -> dict[str, str]:
|
|
"""
|
|
Get any docstrings placed after attribute assignments in a class body.
|
|
|
|
Adapted from https://davidism.com/attribute-docstrings/
|
|
https://davidism.com/mit-license/
|
|
"""
|
|
|
|
def pairwise(iterable):
|
|
"""
|
|
Manually implement https://docs.python.org/3/library/itertools.html#itertools.pairwise
|
|
|
|
Can be removed when Python 3.9 support is dropped.
|
|
"""
|
|
iterator = iter(iterable)
|
|
a = next(iterator, None)
|
|
|
|
for b in iterator:
|
|
yield a, b
|
|
a = b
|
|
|
|
out = {}
|
|
|
|
# Consider each pair of nodes.
|
|
for a, b in pairwise(cls_node.body):
|
|
# Must be an assignment then a constant string.
|
|
if (not isinstance(a, (ast.Assign, ast.AnnAssign))
|
|
or not isinstance(b, ast.Expr)
|
|
or not isinstance(b.value, ast.Constant)
|
|
or not isinstance(b.value.value, str)):
|
|
continue
|
|
|
|
doc = inspect.cleandoc(b.value.value)
|
|
|
|
# An assignment can have multiple targets (a = b = v), but an
|
|
# annotated assignment only has one target.
|
|
targets = a.targets if isinstance(a, ast.Assign) else [a.target]
|
|
|
|
for target in targets:
|
|
# Must be assigning to a plain name.
|
|
if not isinstance(target, ast.Name):
|
|
continue
|
|
|
|
out[target.id] = doc
|
|
|
|
return out
|
|
|
|
|
|
class ConfigValidator(ast.NodeVisitor):
|
|
|
|
def __init__(self):
|
|
...
|
|
|
|
def visit_ClassDef(self, node):
|
|
# Validate class with both @config and @dataclass decorators
|
|
decorators = [
|
|
id for d in node.decorator_list if (isinstance(d, ast.Name) and (
|
|
(id := d.id) == 'config' or id == 'dataclass')) or
|
|
(isinstance(d, ast.Call) and (isinstance(d.func, ast.Name) and
|
|
(id := d.func.id) == 'dataclass'))
|
|
]
|
|
|
|
if set(decorators) == {'config', 'dataclass'}:
|
|
validate_class(node)
|
|
elif set(decorators) == {'config'}:
|
|
fail(
|
|
f"Class {node.name} with config decorator must be a dataclass.",
|
|
node)
|
|
|
|
self.generic_visit(node)
|
|
|
|
|
|
def validate_class(class_node: ast.ClassDef):
|
|
attr_docs = get_attr_docs(class_node)
|
|
|
|
for stmt in class_node.body:
|
|
# A field is defined as a class variable that has a type annotation.
|
|
if isinstance(stmt, ast.AnnAssign):
|
|
# Skip ClassVar
|
|
# see https://docs.python.org/3/library/dataclasses.html#class-variables
|
|
if isinstance(stmt.annotation, ast.Subscript) and isinstance(
|
|
stmt.annotation.value,
|
|
ast.Name) and stmt.annotation.value.id == "ClassVar":
|
|
continue
|
|
|
|
if isinstance(stmt.target, ast.Name):
|
|
field_name = stmt.target.id
|
|
if stmt.value is None:
|
|
fail(
|
|
f"Field '{field_name}' in {class_node.name} must have "
|
|
"a default value.", stmt)
|
|
|
|
if field_name not in attr_docs:
|
|
fail(
|
|
f"Field '{field_name}' in {class_node.name} must have "
|
|
"a docstring.", stmt)
|
|
|
|
if isinstance(stmt.annotation, ast.Subscript) and \
|
|
isinstance(stmt.annotation.value, ast.Name) \
|
|
and stmt.annotation.value.id == "Union" and \
|
|
isinstance(stmt.annotation.slice, ast.Tuple):
|
|
args = stmt.annotation.slice.elts
|
|
literal_args = [
|
|
arg for arg in args
|
|
if isinstance(arg, ast.Subscript) and isinstance(
|
|
arg.value, ast.Name) and arg.value.id == "Literal"
|
|
]
|
|
if len(literal_args) > 1:
|
|
fail(
|
|
f"Field '{field_name}' in {class_node.name} must "
|
|
"use a single "
|
|
"Literal type. Please use 'Literal[Literal1, "
|
|
"Literal2]' instead of 'Union[Literal1, Literal2]'"
|
|
".", stmt)
|
|
|
|
|
|
def validate_ast(tree: ast.stmt):
|
|
ConfigValidator().visit(tree)
|
|
|
|
|
|
def validate_file(file_path: str):
|
|
try:
|
|
print(f"validating {file_path} config dataclasses ", end="")
|
|
with open(file_path, encoding="utf-8") as f:
|
|
source = f.read()
|
|
|
|
tree = ast.parse(source, filename=file_path)
|
|
validate_ast(tree)
|
|
except ValueError as e:
|
|
print(e)
|
|
SystemExit(2)
|
|
else:
|
|
print("✅")
|
|
|
|
|
|
def fail(message: str, node: ast.stmt):
|
|
raise ValueError(f"❌ line({node.lineno}): {message}")
|
|
|
|
|
|
def main():
|
|
for filename in sys.argv[1:]:
|
|
validate_file(filename)
|
|
|
|
|
|
if __name__ == "__main__":
|
|
main()
|