Optimize date utils class: enhance timezone awareness, improve docume…

[MartinKalema]

WHAT DOES THIS PR DO?

• [x] Enhances Timezone Awareness:

  • Ensures that all datetime objects are timezone-aware and explicitly set to UTC to avoid ambiguity and potential errors related to time zone differences.

• [x] Improves Function Documentation:

  • Adds detailed docstrings to all functions, providing clear explanations of parameters, return values, examples of usage, and potential exceptions.

• [x] Streamlines Date Conversion Logic:

  • Simplifies and consolidates date conversion logic to ensure consistent and predictable datetime handling across various functions.

DETAILED DESCRIPTION OF CHANGES

1. Timezone Awareness:

   • Added replace(tzinfo=timezone.utc) to datetime parsing functions to ensure that all datetime objects are timezone-aware and set to UTC.

2. Function Documentation:

   • Updated docstrings for all functions to provide comprehensive explanations, usage examples, and error handling.

3. Date Conversion Functions:

   • Refactored functions like str_to_date, date_to_str, date_to_str_hours, and date_to_str_days to ensure consistent formatting and timezone handling.
   • Simplified logic for determining the first and last days of the week and month.

Summary by CodeRabbit

• New Features

  • Enhanced date and time calculations to be timezone-aware, improving accuracy and consistency.

• Refactor

  • Updated date-related functions to use datetime.now(timezone.utc) instead of datetime.utcnow().

• Improvements

  • Added type annotations to key date-related functions for better code clarity and maintainability.
  • Improved logic for determining first and last days of the month and week.

[coderabbitai[bot]]

Walkthrough

## Walkthrough The recent modifications to the `date.py` file in the `AirQo ETL` project introduce timezone-aware datetime operations to ensure accuracy across different time zones. The updates include replacing `datetime.utcnow()` with `datetime.now(timezone.utc)`, adding type annotations for improved code clarity, and refining methods for handling dates, particularly for calculating start and end dates of weeks and months. ## Changes | File | Change Summary | |----------------------------------------|-----------------------------------------------------------------------------------------------------| | `src/workflows/airqo_etl_utils/date.py`| Introduced `timezone` import; replaced `datetime.utcnow()` with `datetime.now(timezone.utc)`; Added type annotations to functions like `predict_str_to_date`, `str_to_date`, `date_to_str`, and `date_to_str_hours`. Updated date-related methods for accuracy and clarity. | ## Poem > In code's domain, where dates align, > Timezone aware, now working fine. > With type annotations, clear and bright, > ETL flows in the purest light. > Months and weeks now rightly traced, > Future bugs, all effaced! > 🌟✨🕒

---

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]]

Codecov Report

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

Project coverage is 30.30%. Comparing base (ec293ad) to head (8b1bfe0).

Additional details and impacted files

[](https://app.codecov.io/gh/airqo-platform/AirQo-api/pull/3227?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 #3227 +/- ## ======================================== Coverage 30.30% 30.30% ======================================== Files 184 184 Lines 24487 24487 Branches 3205 3205 ======================================== Hits 7421 7421 Misses 16952 16952 Partials 114 114 ```