Skip to content

[BugFix][Typing] Fix Imprecise Type Annotations #15208

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Mar 22, 2025
Merged

[BugFix][Typing] Fix Imprecise Type Annotations #15208

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions vllm/v1/engine/core_client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -212,9 +212,9 @@ class BackgroundResources:
"""Used as a finalizer for clean shutdown, avoiding
circular reference back to the client object."""

ctx: Union[zmq.Context] = None
Copy link
Contributor Author

@WrRan WrRan Mar 20, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ctx must be set, or line-235 will fail because ctx is None.

Copy link
Contributor Author

@WrRan WrRan Mar 20, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I checked the codebase. The BackgroundResources is only used by

vllm/vllm/v1/engine/core_client.py

Line 293 in e3f813c

self.resources = BackgroundResources(ctx=sync_ctx)

So it is ok to remove the defaults.

Copy link
Collaborator

@aarnphm aarnphm Mar 21, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

because this is a dataclass, you can gated the default value under dataclasses.field

ctx: zmq.Context = dataclasses.field(default=None)

Same for L216 and L217

Copy link
Collaborator

@aarnphm aarnphm Mar 21, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

or you can apply the change to L216 and L217 instead of ctx, given that it seems ctx must not be None.

Copy link
Contributor Author

@WrRan WrRan Mar 21, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

because this is a dataclass, you can gated the default value under dataclasses.field

ctx: zmq.Context = dataclasses.field(default=None)

Same for L216 and L217

image Not good. mypy complains.

Copy link
Collaborator

@aarnphm aarnphm Mar 21, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

touche.

output_socket: Union[zmq.Socket, zmq.asyncio.Socket] = None
input_socket: Union[zmq.Socket, zmq.asyncio.Socket] = None
ctx: zmq.Context
output_socket: Optional[Union[zmq.Socket, zmq.asyncio.Socket]] = None
input_socket: Optional[Union[zmq.Socket, zmq.asyncio.Socket]] = None
proc_handle: Optional[BackgroundProcHandle] = None
shutdown_path: Optional[str] = None

Expand Down