Drop JSON output

[CoMPaTech]

Summary by CodeRabbit

• Bug Fixes

  • Updated device status retrieval to always return structured data instead of raw JSON.

• Chores

  • Removed a redundant test related to JSON status output.
  • Bumped project version from 0.1.2 to 0.1.3.

[coderabbitai]

Walkthrough

The status method in airos/airos8.py was refactored to always return an AirOSData object, removing the return_json parameter and its associated logic. The project version in pyproject.toml was incremented. The test_ap_json test function was removed from tests/test_stations.py.

Changes

File(s)	Change Summary
airos/airos8.py	Refactored status method: removed return_json parameter and always returns AirOSData object.
pyproject.toml	Updated project version from 0.1.2 to 0.1.3.
tests/test_stations.py	Removed the test_ap_json asynchronous test function and all related logic.

Estimated code review effort

2 (~12 minutes)

Possibly related PRs

• Bump json to mashumaro #23: Introduced the return_json parameter to the status method, which this PR now removes.
• Revert back to text as a function #12: Modified internal handling of the status method, related to the same area but not the signature.
• Add (very basic) test #10: Updated the status method for connection checks and URL handling, affecting the same method.

Poem

The code now always brings back data neat,
No more toggling JSON with a switch or a cheat.
A version hops up, a test hops away—
AirOS status returns one clear way.
🐇✨
Onward we bound, with changes concise,
Simpler returns—oh, isn’t that nice!

---

📜 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 f571942 and e401a03.

📒 Files selected for processing (3)

• airos/airos8.py (1 hunks)
• pyproject.toml (1 hunks)
• tests/test_stations.py (0 hunks)

💤 Files with no reviewable changes (1)

• tests/test_stations.py

🔇 Additional comments (3)

pyproject.toml (1)

7-7: Appropriate version bump for breaking API change.

The minor version increment correctly reflects the removal of the return_json parameter from the status method, which is a breaking change to the public API.

airos/airos8.py (2)

190-190: Good API simplification by removing optional JSON return.

The method signature is now cleaner and more predictable by always returning a structured AirOSData object instead of conditionally returning raw JSON. This improves type safety and API consistency.

---

191-238: Clean implementation with consistent return behavior.

The method implementation correctly handles all the requirements:

• Proper authentication and connection state checks
• CSRF token handling
• Comprehensive error handling and logging
• Consistent AirOSData object creation and validation
• Warning reporting for data issues

The removal of conditional JSON return logic makes the code more maintainable and type-safe.

✨ Finishing Touches

• 📝 Generate Docstrings

🧪 Generate unit tests

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch testing

---

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

• X
• Mastodon
• Reddit
• LinkedIn

🪧 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 generate unit tests to generate unit tests for 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 or @coderabbitai title 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.