airqo-platform / AirQo-api

This repo contains API definitions for the AirQo platform
MIT License
22 stars 20 forks source link

Update datetime usage: change datetime.utcnow() to datetime.now(timez… #3229

Closed MartinKalema closed 3 months ago

MartinKalema commented 3 months ago

WHAT DOES THIS PR DO?

EXAMPLE

Before

from datetime import datetime

# Getting the current UTC time (naive datetime object)
current_time = datetime.utcnow()

# Converting a timestamp to a naive UTC datetime object
timestamp_time = datetime.utcfromtimestamp(timestamp)

After


from datetime import datetime, timezone

# Getting the current UTC time (timezone-aware datetime object)
current_time = datetime.now(timezone.utc)

# Converting a timestamp to a timezone-aware UTC datetime object
timestamp_time = datetime.fromtimestamp(timestamp, timezone.utc)

Summary by CodeRabbit

coderabbitai[bot] commented 3 months ago

[!WARNING]

Rate limit exceeded

@MartinKalema has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 35 minutes and 2 seconds before requesting another review.

How to resolve this issue? After the wait time has elapsed, a review can be triggered using the `@coderabbitai review` command as a PR comment. Alternatively, push new commits to this PR. We recommend that you space out your commits to avoid hitting the rate limit.
How do rate limits work? CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our [FAQ](https://coderabbit.ai/docs/faq) for further information.
Commits Files that changed from the base of the PR and between b7d1779a564d4f9c3e3b59aad58e5090546cd6c7 and 08f51faba02d9f7f6f7238ccfe78917d8f1f2462.

Walkthrough

The recent changes across multiple files primarily focus on improving consistency by using datetime.now(timezone.utc) instead of datetime.utcnow(). These adjustments ensure accurate and timezone-aware datetime calculations throughout the codebase, enhancing clarity and reliability in time-related functionalities.

Changes

File Path Change Summary
src/.../commons.py Added import for timezone and replaced datetime.utcnow() with datetime.now(timezone.utc).
src/.../date.py Updated DateUtils methods to use timezone.utc for datetime calculations instead of datetime.utcnow().
src/.../utils.py Introduced timezone.utc in datetime import, affecting hour_of_day calculation.
src/.../weather_data_utils.py Modified timestamp formatting to include timezone.utc in datetime functions.
src/.../workflows_custom_utils.py Updated start_date and execution_date_time in AirflowUtils to use timezone.utc instead of utcnow().
src/.../app_notifications.py Switched to datetime.now(timezone.utc) for calculating weekday in notification templates.
src/.../daily_measurements.py Changed start and end date calculations to use datetime.now(timezone.utc) instead of datetime.utcnow().
src/.../data_summary.py Updated datetime handling in data_summary function to use timezone.utc.
src/.../kcca_measurements.py Adjusted hour_of_day calculation to use datetime.now(timezone.utc) for UTC consistency.
src/.../ml_prediction_jobs.py Updated start_date calculations to use datetime.now(timezone.utc) for forecast tasks.
src/.../urban_better_measurements.py Modified hour_of_day calculation in multiple functions to use timezone.utc ensuring correct timezone handling.
src/.../weather_measurements.py Adjusted extract() function to use datetime.now(timezone.utc) for accurate UTC calculations.

Sequence Diagram(s)

No significant modifications to control flow were introduced.

Poem

🌟 In code we trust, with time as our guide,
Converting `utcnow` to `now` with pride.
With `timezone.utc`, precision we chase,
Clean and clear, no errors to trace.
From notifications to ETL's grace,
Each tick of the clock, a smile on its face. ⏰

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 - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `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 generate interesting stats about this repository and render them as a table.` - `@coderabbitai show all the console.log statements in this repository.` - `@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 as 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 resolve` resolve all the CodeRabbit review comments. - `@coderabbitai configuration` to show the current CodeRabbit configuration for the repository. - `@coderabbitai help` to get help. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### CodeRabbit Configration 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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.
codecov[bot] commented 3 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 30.30%. Comparing base (ec293ad) to head (08f51fa). Report is 15 commits behind head on staging.

Additional details and impacted files [![Impacted file tree graph](https://app.codecov.io/gh/airqo-platform/AirQo-api/pull/3229/graphs/tree.svg?width=650&height=150&src=pr&token=HHq3qS3cL6&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=airqo-platform)](https://app.codecov.io/gh/airqo-platform/AirQo-api/pull/3229?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=airqo-platform) ```diff @@ Coverage Diff @@ ## staging #3229 +/- ## ======================================== Coverage 30.30% 30.30% ======================================== Files 184 184 Lines 24487 24487 Branches 3205 3205 ======================================== Hits 7421 7421 Misses 16952 16952 Partials 114 114 ```
MartinKalema commented 3 months ago

@coderabbitai Run black formatter

coderabbitai[bot] commented 3 months ago

[!TIP] For best results, initiate chat on the files or code changes.

@MartinKalema, I'm unable to run the Black formatter directly on the codebase. For applying Black formatting, I recommend running it locally on your machine or integrating it into your CI/CD pipeline. Here's the command you can use to format your Python code locally:

black .

This command will format all Python files in your current directory and its subdirectories according to the Black style guide. If you need help setting up Black in your CI/CD pipeline, feel free to ask!