Skip to content
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.

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

Datetimes are unix timestamps in utc #47

Merged
merged 2 commits into from
Feb 19, 2025
Merged

Datetimes are unix timestamps in utc #47

merged 2 commits into from
Feb 19, 2025

Conversation

silamon
Copy link
Contributor

@silamon silamon commented Feb 2, 2025

Summary by CodeRabbit

  • Bug Fixes

    • Ensured that all time displays now use UTC, improving the consistency and accuracy of time-related information.
  • Tests

    • Updated tests to reflect UTC handling in datetime assertions, enhancing the accuracy of time-related tests.

Copy link
Contributor

coderabbitai bot commented Feb 2, 2025

📝 Walkthrough

Walkthrough

The changes update the _timestamp_to_datetime function in pyrail/models.py so that it converts epoch timestamps into UTC datetime objects. This is accomplished by including the timezone.utc argument in the datetime.fromtimestamp method. Additionally, the import statement has been modified to include timezone alongside datetime. Corresponding updates in tests/test_irail.py ensure that datetime assertions also reflect UTC, enhancing the accuracy of timestamp handling in the tests. No other parts of the code or data models were affected by these changes.

Changes

File(s) Change Summary
pyrail/models.py Updated _timestamp_to_datetime to convert epoch timestamps to UTC using timezone.utc; modified import to include timezone.
tests/test_irail.py Updated tests to reflect UTC in datetime assertions; modified import to include timezone; removed skip decorator from a test.

Poem

I'm a hopping rabbit with a coder's delight,
Watching timestamps swing to UTC from morning to night.
With a tweak in the code, the time now shines so true,
In every tick and tock, the universal view is new.
Code carrots crunch and bunnies dance—UTC leads the cue!


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 90c95c9 and 31c2959.

📒 Files selected for processing (1)
  • tests/test_irail.py (5 hunks)
🔇 Additional comments (3)
tests/test_irail.py (3)

3-3: LGTM!

The import statement has been correctly updated to include timezone from the datetime module, which is necessary for UTC timezone support.


334-341: LGTM! Test cases now correctly verify UTC timestamps.

The test cases have been properly updated to verify that timestamps are converted to UTC datetime objects. The test has also been un-skipped as requested in the PR comments.


343-437: LGTM! Comprehensive test coverage for timestamp deserialization.

The test cases thoroughly verify UTC timestamp deserialization across multiple models:

  • ApiResponse
  • LiveboardDeparture
  • Alert (with both start_time and end_time)
  • Disturbance

All assertions correctly include tzinfo=timezone.utc to ensure proper timezone handling.

✨ Finishing Touches
  • 📝 Generate Docstrings (Beta)

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ 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.
    • Generate unit testing code for this file.
    • 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 generate unit testing code for this file.
    • @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 generate unit testing code.
    • @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.

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. (Beta)
  • @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.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

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.

@tjorim
Copy link
Owner

tjorim commented Feb 2, 2025

Thanks, could you un-skip the timestamp tests to test it out?

@pytest.mark.skip(reason="Timezone is different on different systems")

@pytest.mark.skip(reason="Timezone is different on different systems")

@silamon
Copy link
Contributor Author

silamon commented Feb 3, 2025

Thanks, could you un-skip the timestamp tests to test it out?

@pytest.mark.skip(reason="Timezone is different on different systems")

@pytest.mark.skip(reason="Timezone is different on different systems")

Done.

@silamon
Copy link
Contributor Author

silamon commented Feb 18, 2025

When this is merged, I will go ahead and open the typing/async branch for review in Home Assistant.

@tjorim
Copy link
Owner

tjorim commented Feb 19, 2025

I haven't had the time to test myself, but I trust your judgment 👍

@tjorim tjorim merged commit 4c4ba2c into tjorim:main Feb 19, 2025
4 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.

2 participants