◐ Shell
reader mode source ↗
Skip to content

Handle negative time.sleep values#5906

Merged
youknowone merged 4 commits into
RustPython:mainfrom
ever0de:fix-time/sleep-negative-value-error
Jul 7, 2025
Merged

Handle negative time.sleep values#5906
youknowone merged 4 commits into
RustPython:mainfrom
ever0de:fix-time/sleep-negative-value-error

Conversation

@ever0de

@ever0de ever0de commented Jul 6, 2025

Copy link
Copy Markdown
Contributor

resolved #5895

Summary by CodeRabbit

  • Bug Fixes

    • Improved validation to prevent negative durations when converting from Python objects, ensuring that negative values now raise clear errors.
  • New Features

    • Enhanced error messaging for invalid sleep durations, providing a more user-friendly message when a negative duration is specified.
  • Refactor

    • Updated the sleep function to accept a wider range of Python objects for specifying sleep duration, increasing flexibility in usage.
    • Unified and simplified platform-specific sleep handling for better consistency across environments.

@coderabbitai

coderabbitai Bot commented Jul 6, 2025

Copy link
Copy Markdown
Contributor

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
Loading

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

📥 Commits

Reviewing files that changed from the base of the PR and between 72d612c and 60163b2.

📒 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.

❤️ Share
🪧 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 @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in 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 pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere 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.

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Hide 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 Duration Conversion: Implemented robust checks within the TryFromObject implementation for std::time::Duration. This now prevents the creation of Duration objects from negative Python float or integer values, raising a ValueError with the message "negative duration" if such an attempt is made.
  • Enhanced time.sleep Error Handling: The time.sleep function (for both Unix and non-Unix platforms) has been updated to accept a generic Python object. It now performs explicit type conversion to Duration and includes specific error handling to catch the "negative duration" ValueError from the Duration conversion. 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

  1. 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.

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Hide 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.

@ever0de ever0de changed the title fix(time): Handle negative sleep values Jul 6, 2025

@youknowone youknowone left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Hide comment

Thank you for contributing!

Hide details View details @youknowone youknowone merged commit 240f87a into RustPython:main Jul 7, 2025
12 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

time.sleep(-1.0) causes panic

2 participants