Handle negative time.sleep values #5906
Conversation
WalkthroughThe changes update the Changes
Sequence Diagram(s)sequenceDiagram
participant PythonCode
participant time_sleep
participant TryFromObject
participant RustDuration
PythonCode->>time_sleep: Call sleep(seconds)
time_sleep->>TryFromObject: Convert seconds to Duration
TryFromObject->>TryFromObject: Check if value is negative
alt Negative value
TryFromObject-->>time_sleep: Return ValueError("negative duration")
time_sleep-->>PythonCode: Raise ValueError("sleep length must be non-negative")
else Non-negative value
TryFromObject-->>time_sleep: Return Duration
time_sleep->>RustDuration: Sleep for Duration
time_sleep-->>PythonCode: Return successfully
end
Assessment against linked issues
Poem
📜 Recent review detailsConfiguration used: .coderabbit.yml 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
✨ Finishing Touches
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
Documentation and Community
|
There was a problem hiding this comment.
Summary of Changes
Hello @ever0de, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!
This pull request addresses issue #5895 by ensuring that negative values passed to the time.sleep function are correctly handled. It introduces validation at the Duration conversion level to prevent negative durations from being created and refines the error message presented to the user when time.sleep receives a negative argument, providing a clearer and more consistent experience.
Highlights
- Input Validation for
DurationConversion: Implemented robust checks within theTryFromObjectimplementation forstd::time::Duration. This now prevents the creation ofDurationobjects from negative Python float or integer values, raising aValueErrorwith the message "negative duration" if such an attempt is made. - Enhanced
time.sleepError Handling: Thetime.sleepfunction (for both Unix and non-Unix platforms) has been updated to accept a generic Python object. It now performs explicit type conversion toDurationand includes specific error handling to catch the "negative duration"ValueErrorfrom theDurationconversion. This error is then re-raised with a more user-friendly message: "sleep length must be non-negative", aligning with standard Python behavior.
Using Gemini Code Assist
The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.
Invoking Gemini
You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.
| Feature | Command | Description |
|---|---|---|
| Code Review | /gemini review |
Performs a code review for the current pull request in its current state. |
| Pull Request Summary | /gemini summary |
Provides a summary of the current pull request in its current state. |
| Comment | @gemini-code-assist | Responds in comments when explicitly tagged, both in issue comments and review comments. |
| Help | /gemini help |
Displays a list of available commands. |
Customization
To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.
Limitations & Feedback
Gemini Code Assist is currently in preview and may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments to provide feedback.
You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.
Footnotes
-
Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩
There was a problem hiding this comment.
Code Review
This pull request implements handling for negative sleep values by raising a ValueError. The changes in vm/src/convert/try_from.rs to detect negative numbers when converting to a Duration are well-implemented. The error handling logic for sleep in vm/src/stdlib/time.rs is duplicated across the unix and not(unix) implementations. Refactoring this for better readability and to address the duplication is recommended.
vm/src/stdlib/time.rs
Outdated
| let dur = seconds.try_into_value::<Duration>(vm).map_err(|e| { | ||
| if e.class().is(vm.ctx.exceptions.value_error) { | ||
| // Check if this is a "negative duration" error by examining the args | ||
| if let Some(args) = e.args().first() { | ||
| if let Ok(s) = args.str(vm) { | ||
| if s.as_str() == "negative duration" { | ||
| return vm.new_value_error("sleep length must be non-negative"); | ||
| } | ||
| } | ||
| } | ||
| e | ||
| } else { | ||
| e | ||
| } | ||
| })?; |
There was a problem hiding this comment.
This error mapping logic is verbose and duplicated in the unix implementation of sleep (lines 712-726). Relying on string matching for error messages can be fragile. Consider extracting this logic into a helper function to avoid duplication.
let dur = seconds.try_into_value::<Duration>(vm).map_err(|e| {
if e.class().is(vm.ctx.exceptions.value_error) {
if let Some(s) = e.args().first().and_then(|arg| arg.str(vm).ok()) {
if s.as_str() == "negative duration" {
return vm.new_value_error("sleep length must be non-negative");
}
}
}
e
})?;
vm/src/stdlib/time.rs
Outdated
| let dur = seconds.try_into_value::<Duration>(vm).map_err(|e| { | ||
| if e.class().is(vm.ctx.exceptions.value_error) { | ||
| // Check if this is a "negative duration" error by examining the args | ||
| if let Some(args) = e.args().first() { | ||
| if let Ok(s) = args.str(vm) { | ||
| if s.as_str() == "negative duration" { | ||
| return vm.new_value_error("sleep length must be non-negative"); | ||
| } | ||
| } | ||
| } | ||
| e | ||
| } else { | ||
| e | ||
| } | ||
| })?; |
There was a problem hiding this comment.
This duplicates the error mapping logic in the non-unix sleep function (lines 94-108). Code duplication can lead to maintenance issues. Extract this logic into a shared private helper function used by both sleep implementations.
let dur = seconds.try_into_value::<Duration>(vm).map_err(|e| {
if e.class().is(vm.ctx.exceptions.value_error) {
if let Some(s) = e.args().first().and_then(|arg| arg.str(vm).ok()) {
if s.as_str() == "negative duration" {
return vm.new_value_error("sleep length must be non-negative");
}
}
}
e
})?;| let dur = seconds.try_into_value::<Duration>(vm).map_err(|e| { | ||
| if e.class().is(vm.ctx.exceptions.value_error) { | ||
| if let Some(s) = e.args().first().and_then(|arg| arg.str(vm).ok()) { | ||
| if s.as_str() == "negative duration" { | ||
| return vm.new_value_error("sleep length must be non-negative"); | ||
| } | ||
| } | ||
| } | ||
| e | ||
| })?; |
There was a problem hiding this comment.
Now the two sleep functions share the same error handling.
Originally, the reason they were split was because they didn’t share any logic, so keeping them separate was simpler.
But that’s no longer the case.
Let’s remove #[cfg(not(unix))] from this function and make it the sole function responsible for validating the parameters of sleep.
We should move the cfg checks to the actual implementation instead.
There was a problem hiding this comment.
Currently, the sleep function is implemented directly in the decl module with cfg blocks for platform-specific implementations:
#[pyfunction]
fn sleep(seconds: PyObjectRef, vm: &VirtualMachine) -> PyResult<()> {
let dur = seconds.try_into_value::<Duration>(vm).map_err(..)?;
#[cfg(unix)]
{
// Unix-specific nanosleep implementation
}
#[cfg(not(unix))]
{
// std::thread::sleep for other platforms
}
}Other functions pattern:
// decl module
#[pyfunction]
fn monotonic(vm: &VirtualMachine) -> PyResult<f64> {
Ok(get_monotonic_time(vm)?.as_secs_f64())
}
// platform module
pub(super) fn get_monotonic_time(vm: &VirtualMachine) -> PyResult<Duration> {
// Platform-specific implementation
}Should we refactor sleep to follow the platform pattern for consistency, or it's not necessary since sleep isn't reused and would only involve simple wrapping?
| @@ -691,8 +703,17 @@ mod platform { | |||
| } | |||
|
|
|||
| #[pyfunction] | |||
| fn sleep(dur: Duration, vm: &VirtualMachine) -> PyResult<()> { | |||
| // this is basically std::thread::sleep, but that catches interrupts and we don't want to; | |||
There was a problem hiding this comment.
This comment is not expected to be removed
resolved #5895
Summary by CodeRabbit
Bug Fixes
New Features
Refactor
sleepfunction to accept a wider range of Python objects for specifying sleep duration, increasing flexibility in usage.