Add pydocstyle to the ruff rules (#52136)

Signed-off-by: Harry Mellor <19981378+hmellor@users.noreply.github.com>
Signed-off-by: Harry Mellor <hej.mellor@gmail.com>
Co-authored-by: Claude Opus 5 (1M context) <noreply@anthropic.com>
This commit is contained in:
Harry Mellor
2026-09-16 16:44:29 +00:00
committed by GitHub
co-authored by Claude Opus 5
parent 804e5377aa
commit 8c1557a79c
2002 changed files with 15024 additions and 14269 deletions
+4 -3
View File
@@ -24,12 +24,12 @@ EngineCorePromptLogprobsType = tuple[torch.Tensor, torch.Tensor]
def _build_test_vectors_no_logprobs() -> DummyOutputProcessorTestVectors:
"""Generate output processor dummy test vectors, without logprobs
"""Generate output processor dummy test vectors, without logprobs.
Returns:
DummyOutputProcessorTestVectors instance with no logprobs
"""
"""
tokenizer = AutoTokenizer.from_pretrained(TOKENIZER_NAME)
vllm_config = EngineArgs(model=TOKENIZER_NAME).create_engine_config()
# Tokenize prompts under test & create dummy generated tokens
@@ -62,10 +62,11 @@ def _build_test_vectors_no_logprobs() -> DummyOutputProcessorTestVectors:
@pytest.fixture
def dummy_test_vectors() -> DummyOutputProcessorTestVectors:
"""Generate output processor dummy test vectors, with logprobs
"""Generate output processor dummy test vectors, with logprobs.
Returns:
DummyOutputProcessorTestVectors instance with logprobs
"""
# Build dummy test vectors without logprobs
dtv = _build_test_vectors_no_logprobs()
+3 -7
View File
@@ -1,8 +1,7 @@
# SPDX-License-Identifier: Apache-2.0
# SPDX-FileCopyrightText: Copyright contributors to the vLLM project
"""
Test for the fix in PR #29987: Eagerly abort cancelled final-step requests.
"""Test for the fix in PR #29987: Eagerly abort cancelled final-step requests.
This test verifies that when a request is aborted during its final execution
step (when it would naturally complete), it is properly marked as aborted
@@ -52,8 +51,7 @@ class DummyKVConnectorMetadata(KVConnectorMetadata):
class DummyKVConnector(KVConnectorBase_V1):
"""
Dummy KV connector that captures request finish statuses to a file.
"""Dummy KV connector that captures request finish statuses to a file.
This is used to verify the fix - without the fix, a request aborted
during its final step would be captured as FINISHED_LENGTH_CAPPED
instead of FINISHED_ABORTED.
@@ -144,8 +142,7 @@ KVConnectorFactory.register_connector(
@pytest.mark.parametrize("async_scheduling", [False, True])
@pytest.mark.asyncio
async def test_abort_during_final_step(async_scheduling: bool):
"""
Test that a request aborted during its final execution step is treated as
"""Test that a request aborted during its final execution step is treated as
aborted rather than completed.
This test:
@@ -165,7 +162,6 @@ async def test_abort_during_final_step(async_scheduling: bool):
With the fix, _process_aborts_queue() runs before update_from_output(), so the
abort takes precedence and the KV connector sees FINISHED_ABORTED.
"""
# Create three temporary files:
# 1. ready_file: deleted by execute_model to signal it has started
# 2. block_file: execute_model waits for this to be deleted
-2
View File
@@ -457,7 +457,6 @@ async def test_customize_loggers(monkeypatch):
If a customized logger is provided at the init, it should
be added to the default loggers.
"""
with ExitStack() as after:
with set_default_torch_num_threads(1):
engine = AsyncLLM.from_engine_args(
@@ -642,7 +641,6 @@ async def test_check_health():
@pytest.mark.asyncio
async def test_abort_final_output(output_kind: RequestOutputKind):
"""Test that abort() returns a final output with correct information."""
with ExitStack() as after:
with set_default_torch_num_threads(1):
engine = AsyncLLM.from_engine_args(TEXT_ENGINE_ARGS)
@@ -68,7 +68,8 @@ class _StubEngineCoreActor(EngineCoreActorMixin):
# in ``tests/entrypoints/test_api_server_process_manager.py``.
def _bind_and_report_worker(listen_address, sock, args, client_config):
"""Bind ROUTER/PULL with a kernel-assigned port, report the actual
endpoints back via ``actual_address_pipe``, then exit."""
endpoints back via ``actual_address_pipe``, then exit.
"""
ctx = zmq.Context()
try:
in_sock = make_zmq_socket(
+12 -16
View File
@@ -193,8 +193,7 @@ def test_engine_core():
@create_new_process_for_each_test()
def test_engine_core_advanced_sampling():
"""
A basic end-to-end test to verify that the engine functions correctly
"""A basic end-to-end test to verify that the engine functions correctly
when additional sampling parameters, such as top_p, min_tokens, and
presence_penalty, are set.
"""
@@ -242,9 +241,7 @@ def test_engine_core_advanced_sampling():
@create_new_process_for_each_test()
def test_engine_core_concurrent_batches():
"""
Test that the engine can handle multiple concurrent batches.
"""
"""Test that the engine can handle multiple concurrent batches."""
def make_request_with_max_tokens(req_id: str, max_tokens: int) -> EngineCoreRequest:
request = make_request()
@@ -265,7 +262,6 @@ def test_engine_core_concurrent_batches():
non_block=False,
) -> Future[ModelRunnerOutput | None]:
"""Make execute_model non-blocking."""
# DummyExecutor used only for testing async case.
assert non_block
@@ -282,7 +278,6 @@ def test_engine_core_concurrent_batches():
self, grammar_output, non_block=False
) -> Future[ModelRunnerOutput]:
"""Make sample_tokens non-blocking."""
# DummyExecutor used only for testing async case.
assert non_block
@@ -401,10 +396,7 @@ def test_engine_core_concurrent_batches():
@multi_gpu_test(num_gpus=2)
def test_engine_core_tp():
"""
Test engine can initialize worker in tp properly
"""
"""Test engine can initialize worker in tp properly."""
"""Setup the EngineCore."""
engine_args = EngineArgs(
model=MODEL_NAME,
@@ -490,7 +482,7 @@ def test_encoder_instance_zero_kv_cache(
enable_prefix_caching: bool,
use_kv_connector: bool,
):
"""EPD (Encoder-Prefill-Decode) Encoder-cache-specific tests
"""EPD (Encoder-Prefill-Decode) Encoder-cache-specific tests.
This test verifies encoder-only instance initializes with 0 KV cache blocks.
Under EPD disagg mode, Encoder instances (EC producer role) only execute
@@ -615,7 +607,8 @@ def _cadenced_dp_engine_core(
monkeypatch, results: list[tuple[bool, bool]], dp_sync_interval: int = 32
):
"""A bare DPEngineCoreProc whose all-reduce is scripted by `results`;
returns the core and the step numbers at which the all-reduce ran."""
returns the core and the step numbers at which the all-reduce ran.
"""
core = object.__new__(DPEngineCoreProc)
core.dp_group = object()
core.dp_sync_interval = dp_sync_interval
@@ -634,7 +627,8 @@ def _cadenced_dp_engine_core(
def test_dp_sync_interval_default_is_16():
"""Regression pin: lowering the default narrows the mid-wave pause tail
for async RL, where the engine is rarely idle when pause lands."""
for async RL, where the engine is rarely idle when pause lands.
"""
assert ParallelConfig.dp_sync_interval == 16
@@ -652,7 +646,8 @@ def test_dp_sync_interval_normal_wave(monkeypatch, dp_sync_interval: int):
def test_dp_sync_interval_idle_pause_consensus_on_first_step(monkeypatch):
"""A pause of an idle engine arms every rank before its kick-started
first step, so the step-1 sync reaches consensus after one dummy batch
regardless of the configured cadence."""
regardless of the configured cadence.
"""
core, synced = _cadenced_dp_engine_core(
monkeypatch, [(False, True)], dp_sync_interval=32
)
@@ -678,7 +673,8 @@ def _pausable_engine_core_proc() -> EngineCoreProc:
@pytest.mark.parametrize("deferred", [False, True])
def test_pause_synchronizes_device_before_cache_reset(deferred: bool):
"""A resolved pause promises an idle device: the barrier must run before
caches are cleared and before the caller is unblocked."""
caches are cleared and before the caller is unblocked.
"""
core = _pausable_engine_core_proc()
core.engines_running = deferred
order: list[str] = []
+7 -6
View File
@@ -249,7 +249,8 @@ def test_dplb_non_late_interaction_still_uses_lb():
def test_dplb_burst_round_robins_despite_snapshot_rebinds():
"""A stats snapshot rebind wipes the optimistic lb_engines increments;
the exact in-flight floor must keep a burst spreading round-robin."""
the exact in-flight floor must keep a burst spreading round-robin.
"""
client = _make_dplb_client(num_engines=4)
for _ in range(4):
@@ -324,7 +325,8 @@ async def test_dplb_scale_down_routes_after_stale_stats_snapshot():
def test_dplb_snapshot_backpressure_overrides_inflight():
"""An engine reported heavily loaded by the coordinator is avoided even
when this client has routed nothing to it."""
when this client has routed nothing to it.
"""
client = _make_dplb_client(num_engines=2)
client.lb_engines = [[5, 10, 0.0], [0, 0, 0.0]]
@@ -337,7 +339,8 @@ def test_dplb_snapshot_backpressure_overrides_inflight():
def test_dplb_kv_pressure_amplifies_waiting_penalty():
"""A waiting queue on a KV-bound engine (slow drain) is penalized, while
the same queue with low KV usage is not (e.g. transient burst)."""
the same queue with low KV usage is not (e.g. transient burst).
"""
client = _make_dplb_client(num_engines=2)
# Engine 0 has a smaller total but is KV-bound with a queue.
client.lb_engines = [[5, 10, 1.0], [0, 20, 0.2]]
@@ -1392,11 +1395,9 @@ def test_startup_failure(monkeypatch: pytest.MonkeyPatch):
@create_new_process_for_each_test()
def test_engine_core_proc_instantiation_cuda_empty(monkeypatch: pytest.MonkeyPatch):
"""
Test that EngineCoreProc can be instantiated when CUDA_VISIBLE_DEVICES
"""Test that EngineCoreProc can be instantiated when CUDA_VISIBLE_DEVICES
is empty. This ensures the engine frontend does not need access to GPUs.
"""
from vllm.v1.engine.core import EngineCoreProc
from vllm.v1.executor.abstract import Executor
@@ -11,8 +11,7 @@ from vllm.v1.engine.detokenizer import IncrementalDetokenizer
def test_fast_inc_detok_invalid_utf8_err_case():
"""
Test edge case where tokenizer can produce non-monotonic,
"""Test edge case where tokenizer can produce non-monotonic,
invalid UTF-8 output, which breaks the internal state of
tokenizers' DecodeStream.
See https://github.com/vllm-project/vllm/issues/17448.
+2 -1
View File
@@ -82,7 +82,7 @@ def _get_test_sampling_params(
rng = random.Random(seed)
def get_mostly_n_gt1() -> int:
r"""Mostly n \in [2,20], ~1/3 n=1"""
r"""Mostly n \in [2,20], ~1/3 n=1."""
x = rng.randint(0, 28)
if x < 10:
return 1
@@ -125,6 +125,7 @@ def test_parallel_sampling(vllm_model, example_prompts) -> None:
Args:
vllm_model: VllmRunner instance under test.
example_prompt: test fixture providing prompts for testing.
"""
sampling_params_list, n_list = _get_test_sampling_params(example_prompts)
llm: LLM = vllm_model.llm
+2 -1
View File
@@ -30,7 +30,8 @@ def _make_processor(num_logprobs: int) -> LogprobsProcessor:
def test_drops_trailing_sentinel_columns():
"""A request that asked for 3 custom token logprobs but ended up in a
batch padded to width 5 must not surface the trailing -inf entries."""
batch padded to width 5 must not surface the trailing -inf entries.
"""
processor = _make_processor(num_logprobs=3)
sampled = 42
+4 -1
View File
@@ -73,6 +73,7 @@ def _ref_convert_id_to_token(
Returns:
String representation of input token id
"""
return tokenizer.decode([token_id]) or ""
@@ -228,7 +229,8 @@ def test_request_stream_interval_raises_but_not_below_engine_default(
):
"""A per-request stream_interval can raise the interval above the engine
default but not below it (values under the default clamp up), without
altering the generated text."""
altering the generated text.
"""
engine_stream_interval = 5
# Request 0 (below the default) clamps up to 5; request 1 raises it to 10.
request_stream_intervals = [1, 10]
@@ -792,6 +794,7 @@ def test_stop_token(
stop_token_type: "eos_token_id" for EOS, "stop_token_ids" for stop token
ignore_eos: if True, EOS stops are disabled
dummy_test_vectors: dummy engine core outputs and other data structures
"""
model_id = dummy_test_vectors.tokenizer.name_or_path
if model_id != "meta-llama/Llama-3.2-1B":
@@ -14,7 +14,6 @@ MODEL_NAME = "hmellor/tiny-random-LlamaForCausalLM"
def test_preprocess_error_handling(monkeypatch: pytest.MonkeyPatch):
"""Test that preprocessing errors are handled gracefully."""
if current_platform.is_rocm() or current_platform.is_xpu():
pytest.skip(
"Skipped on ROCm/XPU: this test only works with 'fork', "
+14 -8
View File
@@ -54,6 +54,7 @@ def _create_random_top_logprob_test_vector(
Returns:
1D length-`num_logprobs` torch Tensor of float logprob values
"""
return torch.rand(num_logprobs) * (upper - lower) + lower
@@ -79,6 +80,7 @@ def _create_random_top_logprob_test_matrix(
Returns:
2D num_tokens x num_logprobs torch Tensor of float logprob values
"""
return torch.rand(*shape) * (upper - lower) + lower
@@ -90,7 +92,7 @@ def _create_random_top_token_test_vector(
sampled_token_id: int,
adjust_num_logprobs: bool = True,
) -> tuple[torch.Tensor, int]:
"""Create a random vector of top logprob token indices
"""Create a random vector of top logprob token indices.
Use to create fake sample logprobs for testing. The sampled token
ID must always be one of the top logprobs, which this dummy test
@@ -117,8 +119,8 @@ def _create_random_top_token_test_vector(
sampled_token_rank: the rank of sampled_token_id in the vocab
vector when sorted in descending order by
logprob
"""
"""
# Calculate the final number of logprobs required
total_logprobs = num_logprobs + 1 if adjust_num_logprobs else num_logprobs
@@ -148,7 +150,7 @@ def _create_random_top_token_test_matrix(
upper: int,
tokens_list: list[int],
) -> tuple[torch.Tensor, torch.Tensor]:
"""Create a random matrix of top logprob token indices
"""Create a random matrix of top logprob token indices.
Use to create fake prompt logprobs for testing.
@@ -166,6 +168,7 @@ def _create_random_top_token_test_matrix(
- 2D num_tokens x num_logprobs+1 torch Tensor of token ids
- 1D tensor of ranks of prompt tokens in their respective
rows, or random values
"""
num_elements = shape[0] * shape[1]
choice_tensor = torch.randperm(upper - lower)[:num_elements] + lower
@@ -205,6 +208,7 @@ def decode_token(
Returns:
string representation of token
"""
return tokenizer.convert_ids_to_tokens(tok_id)
@@ -214,7 +218,7 @@ def generate_dummy_sample_logprobs(
num_logprobs: int,
tokenizer: PythonBackend,
) -> list[tuple[list[int], list[float], int]]:
"""Generate dummy sample logprobs
"""Generate dummy sample logprobs.
Generate a test data structure which imitates the list of sample logprobs
which would be assembled in the engine core during decode phase.
@@ -224,13 +228,14 @@ def generate_dummy_sample_logprobs(
num_logprobs: return `num_logprobs` or `num_logprobs+1` logprobs per token
tokenizer: model tokenizer to use for detokenization
Returns
Returns:
list of (top token ids vector, logprobs vector, sampled token rank)
Python lists tuples; in each tuple the logprobs and top token ids
vectors have the same length which is either `num_logprobs` or
`num_logprobs+1`. Sampled token rank is the rank (index+1) of the
sampled token within the vocab vector when sorted by logprob in
descending order.
"""
res = []
for sampled_token_id in sampled_tokens_list:
@@ -263,7 +268,7 @@ def generate_dummy_prompt_logprobs_tensors(
num_logprobs: int,
tokenizer: PythonBackend,
) -> LogprobsTensors:
"""Generate dummy prompt logprobs tensors
"""Generate dummy prompt logprobs tensors.
Generate a test data structure which imitates the torch Tensors of prompt
logprobs which would be assembled in the engine core during chunked
@@ -274,10 +279,11 @@ def generate_dummy_prompt_logprobs_tensors(
num_logprobs: return `num_logprobs` logprobs per token
tokenizer: model tokenizer to use for detokenization
Returns
Returns:
Single tuple of (logprobs matrix, top token ids matrix) torch Tensor,
where both matrices have dimensions
num_prompt_tokens x num_logprobs
"""
# For now, assume the whole prompt is processed in one chunk; thus,
# the number of non-`None` prompt logprobs is `len(prompt_tokens_list)-1`.
@@ -308,7 +314,7 @@ def generate_dummy_prompt_logprobs_tensors(
@dataclass
class DummyOutputProcessorTestVectors:
"""Dummy test vectors for output processor tests"""
"""Dummy test vectors for output processor tests."""
tokenizer: GeneralTokenizerType
vllm_config: EngineArgs