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

Update/integration iqair devices #3962

Conversation

NicholasTurner23
Copy link
Contributor

@NicholasTurner23 NicholasTurner23 commented Dec 2, 2024

Description

This PR switches all extract device data implementation to the extract device data by networks.

Summary by CodeRabbit

  • New Features

    • Enhanced data extraction process for AirQo devices, improving reliability and error handling.
  • Bug Fixes

    • Corrected method call to ensure proper data retrieval within the extraction workflow.
  • Documentation

    • Updated docstrings for clarity and proper association with respective functions.

Copy link
Contributor

coderabbitai bot commented Dec 2, 2024

📝 Walkthrough

Walkthrough

This pull request introduces significant modifications to the AirQoDataUtils class in airqo_utils.py, particularly the extract_devices_data method. The method underwent a temporary renaming but ultimately retained its original name. Enhancements to the internal logic include improved checks for device categories, better error handling, and refined data processing. Additionally, the extract_raw_data function in airqo_measurements.py was updated to correctly reference the extract_devices_data method. Documentation for certain functions was also improved without altering their functionality.

Changes

File Path Change Summary
src/workflows/airqo_etl_utils/airqo_utils.py - Modified extract_devices_data method for improved data extraction and error handling.
- Temporary renaming of the method to extract_devices_data_ and reverted back.
src/workflows/dags/airqo_measurements.py - Corrected method call from extract_devices_data_ to extract_devices_data.
- Updated documentation for clean_data_raw_data and send_raw_measurements_to_bigquery.

Possibly related PRs

Suggested labels

ready for review

Suggested reviewers

  • Baalmart
  • BenjaminSsempala
  • Psalmz777

🌟 In the realm of code, a dance took place,
With methods renaming, a temporary chase.
Data extraction, now clearer and bright,
Error handling improved, a wonderful sight!
From devices to networks, all flows align,
In the world of AirQo, everything's fine! 🌟


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

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (4)
src/workflows/airqo_etl_utils/airqo_utils.py (4)

Line range hint 398-537: Consider removing deprecated method extract_devices_data_

The method extract_devices_data_ appears to be an outdated version of extract_devices_data and may no longer be in use. Removing unused or deprecated code enhances maintainability and reduces confusion.


Line range hint 552-573: Use appropriate logging methods outside exception handling

The use of logger.exception() is intended for logging exceptions within an except block. In this context, where no exception is being raised, consider using logger.error() or logger.warning() instead.

Apply the following changes:

- if not devices:
-     logger.exception("Failed to fetch devices.")
+ if not devices:
+     logger.error("Failed to fetch devices.")

...

- if device_number and read_key is None:
-     logger.exception(f"{device_number} does not have a read key")
+ if device_number and read_key is None:
+     logger.warning(f"{device_number} does not have a read key")

...

- except Exception as e:
-     logger.exception(f"An error occured: {e} - device {device['name']}")
+ except Exception as e:
+     logger.exception(f"An error occurred: {e} - device {device['name']}")

Note: Corrected the typo in "occurred" in the exception message.


Line range hint 600-612: Potential NameError due to undefined meta_data for IQAir devices

When processing IQAir devices (network == "iqair"), the variable meta_data may not be defined before it's used to assign latitude and longitude. This could lead to a NameError. To prevent this, ensure that latitude and longitude are fetched correctly for IQAir devices.

Apply the following changes:

- if device_category in AirQoDataUtils.Device_Field_Mapping:
-     data["latitude"] = device.get("latitude", None)
-     data["longitude"] = device.get("longitude", None)
- else:
-     data["latitude"] = meta_data.get("latitude", None)
-     data["longitude"] = meta_data.get("longitude", None)
+ data["latitude"] = device.get("latitude", None)
+ data["longitude"] = device.get("longitude", None)

This change ensures that latitude and longitude are consistently obtained from the device dictionary, preventing potential errors.


Line range hint 559-575: Ensure consistent data types for data across device networks

The variable data is used differently for 'airqo' and 'iqair' networks:

  • For 'airqo', data is a list that accumulates data over multiple dates.
  • For 'iqair', data is assigned directly as a DataFrame.

This inconsistency may cause issues during concatenation with devices_data. It's advisable to standardize data as a DataFrame in both cases.

Suggested adjustments:

  • Initialize data as an empty DataFrame before the loops.
  • For 'airqo', after collecting data, convert it to a DataFrame.
  • Ensure that data is consistently a DataFrame before concatenation.
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between b309085 and 7f1c60c.

📒 Files selected for processing (2)
  • src/workflows/airqo_etl_utils/airqo_utils.py (2 hunks)
  • src/workflows/dags/airqo_measurements.py (1 hunks)
🧰 Additional context used
📓 Learnings (1)
src/workflows/dags/airqo_measurements.py (1)
Learnt from: AnthonyByansi
PR: airqo-platform/AirQo-api#3262
File: src/workflows/dags/airqo_measurements.py:0-0
Timestamp: 2024-11-12T09:15:21.461Z
Learning: The dataset name `AirQodataset` was corrected to `AirQo-dataset` in multiple places within the `airqo_measurements.py` file to ensure consistency.
🔇 Additional comments (1)
src/workflows/dags/airqo_measurements.py (1)

496-499: Method call correctly updated to extract_devices_data

The function now appropriately calls AirQoDataUtils.extract_devices_data, ensuring correct data extraction as per the updated method.

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