Skip to content

stdlib: Add Shutdown error and shutdown method to queue module #11489

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 3 commits into from
Feb 29, 2024
Merged

stdlib: Add Shutdown error and shutdown method to queue module #11489

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
0e4cb7a
stdlib: Add Shutdown error and shutdown method to queue module
aisk Feb 27, 2024
a5a3636
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Feb 28, 2024
42cff1e
Update stdlib/queue.pyi
JelleZijlstra Feb 29, 2024
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
8 changes: 8 additions & 0 deletions stdlib/queue.pyi
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,9 @@ _T = TypeVar("_T")
class Empty(Exception): ...
class Full(Exception): ...

if sys.version_info >= (3, 13):
class ShutDown(Exception): ...

class Queue(Generic[_T]):
maxsize: int

Expand All @@ -20,6 +23,8 @@ class Queue(Generic[_T]):
not_full: Condition # undocumented
all_tasks_done: Condition # undocumented
unfinished_tasks: int # undocumented
if sys.version_info >= (3, 13):
is_shutdown: bool # undocumented
# Despite the fact that `queue` has `deque` type,
# we treat it as `Any` to allow different implementations in subtypes.
queue: Any # undocumented
Expand All @@ -29,6 +34,9 @@ class Queue(Generic[_T]):
def full(self) -> bool: ...
def get(self, block: bool = True, timeout: float | None = None) -> _T: ...
def get_nowait(self) -> _T: ...
if sys.version_info >= (3, 13):
def shutdown(self, immediate: bool = False) -> None: ...

def _get(self) -> _T: ...
def put(self, item: _T, block: bool = True, timeout: float | None = None) -> None: ...
def put_nowait(self, item: _T) -> None: ...
Expand Down