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
+32 -36
View File
@@ -63,12 +63,12 @@ class MultiModalCacheMissError(RuntimeError):
class MultiModalProcessorCacheItem:
"""
The data to store inside `MultiModalProcessorOnlyCache`.
"""The data to store inside `MultiModalProcessorOnlyCache`.
Args:
item: The processed tensor data corresponding to a multi-modal item.
prompt_updates: The prompt updates corresponding to `item`.
"""
def __init__(
@@ -83,8 +83,7 @@ class MultiModalProcessorCacheItem:
class MultiModalProcessorCacheItemMetadata:
"""
The metadata to store inside `MultiModalProcessorSenderCache`.
"""The metadata to store inside `MultiModalProcessorSenderCache`.
Args:
item: The processed tensor data corresponding to a multi-modal item.
@@ -94,6 +93,7 @@ class MultiModalProcessorCacheItemMetadata:
prompt_updates: The prompt updates corresponding to `item`.
This needs to stay on P0 because for some models, they are
dependent on the processed tensor data (cached on P1).
"""
def __init__(
@@ -163,8 +163,7 @@ class MultiModalCache:
@classmethod
def get_item_complexity(cls, value: MultiModalCacheValue) -> int:
"""
Get the number of leaf elements in a multi-modal cache value.
"""Get the number of leaf elements in a multi-modal cache value.
This provides a measure of structural complexity that can be useful
for debugging cache performance and understanding data patterns.
@@ -174,6 +173,7 @@ class MultiModalCache:
Returns:
The number of leaf elements in the nested structure.
"""
return json_count_leaves(value)
@@ -196,8 +196,7 @@ _O = TypeVar("_O", covariant=True)
class BaseMultiModalCache(ABC, Generic[_I, _O]):
"""
Abstract base class to read/write multi-modal items from cache.
"""Abstract base class to read/write multi-modal items from cache.
The idea of multi-modal caching is based on having a client and server
where the client executes in the frontend process (=P0) and
@@ -226,8 +225,7 @@ class BaseMultiModalCache(ABC, Generic[_I, _O]):
mm_item: _I,
mm_hash: str,
) -> _O:
"""
Possibly update a multi-modal item based on whether it is
"""Possibly update a multi-modal item based on whether it is
in the underlying cache.
This update is done out-of-place and updates the cache eviction order.
@@ -238,6 +236,7 @@ class BaseMultiModalCache(ABC, Generic[_I, _O]):
Returns:
The update multi-modal item.
"""
raise NotImplementedError
@@ -246,8 +245,7 @@ class BaseMultiModalCache(ABC, Generic[_I, _O]):
mm_items: Sequence[_I],
mm_hashes: list[str],
) -> list[_O]:
"""
Possibly update a sequence of multi-modal items based on whether they
"""Possibly update a sequence of multi-modal items based on whether they
are in the underlying cache.
This update is done out-of-place and updates the cache eviction order.
@@ -258,6 +256,7 @@ class BaseMultiModalCache(ABC, Generic[_I, _O]):
Returns:
A new list of updated multi-modal items.
"""
assert len(mm_items) == len(mm_hashes)
@@ -289,6 +288,7 @@ class BaseMultiModalCache(ABC, Generic[_I, _O]):
Returns:
`True` if the item was cached, otherwise `False`.
"""
if cache.put_if_fits(key, value):
return True
@@ -325,8 +325,7 @@ class BaseMultiModalProcessorCache(
@abstractmethod
def is_cached_item(self, mm_hash: str) -> bool:
"""
Check whether a multi-modal item is
"""Check whether a multi-modal item is
in the underlying cache.
This **DOES NOT** update the cache eviction order.
@@ -336,12 +335,12 @@ class BaseMultiModalProcessorCache(
Returns:
`True` if the item is cached, otherwise `False`.
"""
raise NotImplementedError
def is_cached(self, mm_hashes: list[str]) -> list[bool]:
"""
Check whether a sequence of multi-modal items are
"""Check whether a sequence of multi-modal items are
in the underlying cache.
This **DOES NOT** update the cache eviction order.
@@ -351,6 +350,7 @@ class BaseMultiModalProcessorCache(
Returns:
For each item, `True` if the item is cached, otherwise `False`.
"""
return [self.is_cached_item(mm_hash) for mm_hash in mm_hashes]
@@ -367,31 +367,30 @@ class BaseMultiModalProcessorCache(
@abstractmethod
def touch_sender_cache_item(self, mm_hash: str) -> None:
"""
Update the cache eviction order for a multi-modal item.
"""Update the cache eviction order for a multi-modal item.
This is used to touch the item in the cache without changing
its value.
Args:
mm_hash: The hash of the multi-modal item.
"""
raise NotImplementedError
@abstractmethod
def make_stats(self, *, delta: bool = False) -> CacheInfo:
"""
Get (and reset) the multi-modal cache stats.
"""Get (and reset) the multi-modal cache stats.
Returns:
The current multi-modal caching stats.
"""
raise NotImplementedError
class MultiModalProcessorOnlyCache(BaseMultiModalProcessorCache):
"""
The cache which is used on P0 when IPC caching is disabled.
"""The cache which is used on P0 when IPC caching is disabled.
How to update each item:
@@ -442,8 +441,7 @@ class MultiModalProcessorOnlyCache(BaseMultiModalProcessorCache):
class MultiModalProcessorSenderCache(BaseMultiModalProcessorCache):
"""
The cache which is used on P0 when IPC caching is enabled.
"""The cache which is used on P0 when IPC caching is enabled.
How to update each item:
@@ -507,8 +505,7 @@ class MultiModalProcessorSenderCache(BaseMultiModalProcessorCache):
class ShmObjectStoreSenderCache(BaseMultiModalProcessorCache):
"""
The cache which is used on P0 when IPC caching is enabled.
"""The cache which is used on P0 when IPC caching is enabled.
How to update each item:
@@ -609,7 +606,8 @@ class ShmObjectStoreSenderCache(BaseMultiModalProcessorCache):
@override
def touch_sender_cache_item(self, mm_hash: str) -> None:
"""Touch the item in shared memory cache to prevent eviction.
Increments writer_flag on sender side."""
Increments writer_flag on sender side.
"""
self._shm_cache.touch(mm_hash)
@override
@@ -662,8 +660,7 @@ class BaseMultiModalReceiverCache(
self,
mm_features: list["MultiModalFeatureSpec"],
) -> list["MultiModalFeatureSpec"]:
"""
Update multimodal features with cached encoder outputs.
"""Update multimodal features with cached encoder outputs.
Touch all identifier at first before update to avoid
item in updated list evict during update.
@@ -695,8 +692,7 @@ class BaseMultiModalReceiverCache(
mm_hash: str,
mm_item: MultiModalKwargsItem | None = None,
) -> None:
"""
Update the cache eviction order for a multi-modal item.
"""Update the cache eviction order for a multi-modal item.
This is used to touch the item in the cache without changing
its value.
@@ -705,13 +701,13 @@ class BaseMultiModalReceiverCache(
mm_hash: The hash of the multi-modal item.
mm_item: The multi-modal item itself. This is optional and
may not be needed by some cache implementations.
"""
raise NotImplementedError
class MultiModalReceiverCache(BaseMultiModalReceiverCache):
"""
The cache which is used on P1 when IPC caching is enabled.
"""The cache which is used on P1 when IPC caching is enabled.
How to update each item:
@@ -762,8 +758,7 @@ class MultiModalReceiverCache(BaseMultiModalReceiverCache):
class ShmObjectStoreReceiverCache(BaseMultiModalReceiverCache):
"""
The cache which is used on P1 Worker Process when IPC caching is enabled.
"""The cache which is used on P1 Worker Process when IPC caching is enabled.
How to update each item:
@@ -827,7 +822,8 @@ class ShmObjectStoreReceiverCache(BaseMultiModalReceiverCache):
mm_item: MultiModalKwargsItem | None = None,
) -> None:
"""Touch the item in shared memory cache to prevent eviction.
Increments reader_count on receiver side."""
Increments reader_count on receiver side.
"""
assert mm_item is not None
if "address" in mm_item:
address = cast(int, mm_item["address"].data)