Handle negative time.sleep values by ever0de · Pull Request #5906 · RustPython/RustPython
Walkthrough
The changes update the TryFromObject implementation for std::time::Duration to explicitly reject negative values from Python floats and integers, raising a ValueError. The time.sleep function is refactored to accept a generic Python object for seconds, convert to Duration, improve error messaging for negative values, and unify Unix/non-Unix implementations.
Changes
| File(s) | Change Summary |
|---|---|
| vm/src/convert/try_from.rs | Added explicit negative value checks for float and integer conversions to Duration. |
| vm/src/stdlib/time.rs | Refactored sleep to accept a Python object, convert to Duration, improve error messaging, remove old Unix-specific sleep, and unify Unix/non-Unix implementations. |
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
| Objective | Addressed | Explanation |
|---|---|---|
| Raise exception when time.sleep is called with a negative value (#5895) | ✅ | |
| Prevent panic when negative values are passed to time.sleep (#5895) | ✅ | |
| Provide user-friendly error message for negative sleep durations (#5895) | ✅ |
Poem
In the land of code, a rabbit leaps,
Guarding sleep from negative deeps.
With checks in place, no panic’s found—
Only friendly errors abound!
Now time.sleep is safe and bright,
Rest easy, code, all through the night.
🐇✨
📜 Recent review details
Configuration used: .coderabbit.yml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
vm/src/stdlib/time.rs(2 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
- vm/src/stdlib/time.rs
✨ Finishing Touches
- 📝 Generate Docstrings
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.
🪧 Tips
Chat
There are 3 ways to chat with CodeRabbit:
- Review comments: Directly reply to a review comment made by CodeRabbit. Example:
I pushed a fix in commit <commit_id>, please review it.Explain this complex logic.Open a follow-up GitHub issue for this discussion.
- Files and specific lines of code (under the "Files changed" tab): Tag
@coderabbitaiin a new review comment at the desired location with your query. Examples:@coderabbitai explain this code block.@coderabbitai modularize this function.
- PR comments: Tag
@coderabbitaiin a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:@coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.@coderabbitai read src/utils.ts and explain its main purpose.@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.@coderabbitai help me debug CodeRabbit configuration file.
Support
Need 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)
@coderabbitai pauseto pause the reviews on a PR.@coderabbitai resumeto resume the paused reviews.@coderabbitai reviewto trigger an incremental review. This is useful when automatic reviews are disabled for the repository.@coderabbitai full reviewto do a full review from scratch and review all the files again.@coderabbitai summaryto regenerate the summary of the PR.@coderabbitai generate docstringsto generate docstrings for this PR.@coderabbitai generate sequence diagramto generate a sequence diagram of the changes in this PR.@coderabbitai resolveresolve all the CodeRabbit review comments.@coderabbitai configurationto show the current CodeRabbit configuration for the repository.@coderabbitai helpto get help.
Other keywords and placeholders
- Add
@coderabbitai ignoreanywhere in the PR description to prevent this PR from being reviewed. - Add
@coderabbitai summaryto generate the high-level summary at a specific location in the PR description. - Add
@coderabbitaianywhere in the PR title to generate the title automatically.
Documentation and Community
- Visit our Documentation for detailed information on how to use CodeRabbit.
- Join our Discord Community to get help, request features, and share feedback.
- Follow us on X/Twitter for updates and announcements.