Bump json to mashumaro #23

CoMPaTech · 2025-07-22T12:28:36Z

Summary by CodeRabbit

New Features
- Introduced a comprehensive and strongly typed data model for AirOS device data, enabling structured parsing and validation.
- The device status method now supports returning either a structured object or raw JSON, with improved warning handling for unknown values.
Documentation
- Updated the README to include an example that prints the wireless mode from the device status.
Chores
- Updated dependencies to include mashumaro and removed asyncio.
- Bumped project version to 0.1.2.
Style
- Corrected GPS coordinates in sample JSON fixture files for accuracy.
Tests
- Added new test to verify device status retrieval returns structured data objects alongside existing JSON-based tests.

coderabbitai · 2025-07-22T12:28:41Z

Warning

Rate limit exceeded

@CoMPaTech has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 2 minutes and 24 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 for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between 6e272ae and e4ad2ca.

📒 Files selected for processing (2)

airos/airos8.py (3 hunks)
airos/airos8data.py (1 hunks)

"""

Walkthrough

A new data model for AirOS device data was introduced using Python dataclasses and enums in a new file. The status method was refactored to return a structured object or raw JSON, with improved error handling and warning generation for unknown fields. Documentation and fixture files were updated, and dependencies were adjusted to support the new data model.

Changes

Files / Groups	Change Summary
airos/airos8data.py	Added: New file defining comprehensive dataclasses and enums for AirOS device data, with validation and warning support.
airos/airos8.py	Modified: `status` method now returns structured data or JSON, adds error handling, uses new data model, and updates method signature.
README.md	Modified: Added example print statement for wireless mode in usage section.
fixtures/ap-ptp.json, fixtures/sta-ptp.json	Modified: Updated GPS coordinates for accuracy; no structural or other content changes.
pyproject.toml	Modified: Version bumped to 0.1.2; added `mashumaro` as a dependency.
requirements.txt	Modified: Replaced `asyncio` with `mashumaro`; retained `aiohttp`.
tests/test_stations.py	Added: New test function `test_ap_object` to validate `AirOSData` object return; renamed existing test to `test_ap_json`.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant AirOS
    participant AirOSData

    User->>AirOS: status(return_json=False)
    AirOS->>AirOS: Fetch device status JSON
    AirOS->>AirOSData: AirOSData.from_dict(json)
    alt Deserialization fails
        AirOS->>User: Raise KeyDataMissingError
    else Success
        AirOS->>User: Return AirOSData object
    end

Estimated code review effort

4 (~90 minutes)

Possibly related PRs

Revert back to text as a function #12: Modifies the status method’s JSON handling and awaiting logic, related to internal response processing.
Add (very basic) test #10: Adds basic tests for the status method but lacks the detailed data model deserialization and warning logic introduced here.

Suggested labels

enhancement

Poem

A rabbit hopped through code so neat,
With dataclasses, enums—a structured treat!
GPS now points to places true,
And warnings guide what’s old or new.
Dependencies fresh, the docs in line,
This AirOS update works just fine!
🐇✨
"""

✨ 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

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

coderabbitai

Actionable comments posted: 7

🧹 Nitpick comments (3)

pyproject.toml (1)

7-7: Remember to tag & publish 0.1.2

Version bump looks fine; ensure the changelog and release workflow are updated accordingly.
README.md (1)
25-25: Clarify return type before attribute access

result may still be a raw dict if the caller doesn’t pass typed=True (or similar flag) to status(). Accessing result.wireless.mode would raise AttributeError.

Add a brief note or guard in the snippet:
result = await device.status(typed=True)
print(result.wireless.mode)
This avoids confusion for copy-paste users.
airos/airos8data.py (1)
377-382: Overly broad union types reduce type safety

The union types for provmode and ntpclient are extremely broad, accepting almost any type. This defeats the purpose of type checking.

Consider narrowing the union types to be more specific:
-    provmode: (
-        ProvisioningMode | str | dict[str, Any] | list[Any] | Any
-    )  # If it can be populated, define its fields
-    ntpclient: (
-        NtpClient | str | dict[str, Any] | list[Any] | Any
-    )  # If it can be populated, define its fields
+    provmode: ProvisioningMode | dict[str, Any]
+    ntpclient: NtpClient | dict[str, Any]

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 45d51d3 and f19ad7a.

📒 Files selected for processing (8)

README.md (1 hunks)
airos/airos8.py (3 hunks)
airos/airos8data.py (1 hunks)
fixtures/ap-ptp.json (1 hunks)
fixtures/sta-ptp.json (1 hunks)
pyproject.toml (2 hunks)
requirements.txt (1 hunks)
tests/test_stations.py (3 hunks)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)

GitHub Check: Run pytest using Python 3.13

🔇 Additional comments (2)

requirements.txt (1)

2-2: LGTM – new dependency added

mashumaro==3.16 is correctly pinned. No issues spotted here.
pyproject.toml (1)

25-25: Pinning style differs from requirements.txt

requirements.txt pins mashumaro==3.16, whereas pyproject.toml uses an unpinned "mashumaro" entry. To avoid accidental breaking upgrades in downstream builds, mirror the exact version spec here too:
-        "mashumaro",
+        "mashumaro==3.16",

airos/airos8.py

airos/airos8data.py

fixtures/ap-ptp.json

fixtures/sta-ptp.json

tests/test_stations.py

Bump json to mashumaro

65d84ac

CoMPaTech added 2 commits July 22, 2025 14:42

Fix testing

f19ad7a

Fix testing

6e272ae

coderabbitai bot requested changes Jul 22, 2025

View reviewed changes

CoMPaTech temporarily deployed to testpypi July 22, 2025 12:47 — with GitHub Actions Inactive

CoMPaTech added 2 commits July 22, 2025 14:52

Improvements and CRAI suggestions

057e5d2

Improvements and CRAI suggestions

e4ad2ca

CoMPaTech temporarily deployed to testpypi July 22, 2025 12:54 — with GitHub Actions Inactive

coderabbitai bot approved these changes Jul 22, 2025

View reviewed changes

CoMPaTech merged commit f571942 into main Jul 22, 2025
9 checks passed

CoMPaTech temporarily deployed to pypi July 22, 2025 12:57 — with GitHub Actions Inactive

CoMPaTech deleted the testing branch July 22, 2025 12:58

This was referenced Jul 22, 2025

Drop JSON output #24

Merged

Add IEEE Auto mode (and less warnings) #25

Merged

Classing #28

Merged

Add discovery and improve consistency #33

Merged

Fix apmac and add determined mac address #35

Merged

Fixture generation for derived #36

Merged

This was referenced Aug 3, 2025

Add missing Litebeam 5AC options #45

Merged

Improvements #47

Merged

Improvements #48

Merged

Fix age field in Remote for nanostation 8.7.11 #52

Merged

coderabbitai bot mentioned this pull request Aug 14, 2025

add LiteBeam 5AC bridge config from /status.cgi #63

Merged

coderabbitai bot mentioned this pull request Aug 30, 2025

Introduce basic v6 support #83

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Bump json to mashumaro #23

Bump json to mashumaro #23

Uh oh!

CoMPaTech commented Jul 22, 2025 •

edited by coderabbitai bot

Loading

Uh oh!

coderabbitai bot commented Jul 22, 2025 •

edited

Loading

Rate limit exceeded

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

coderabbitai bot left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

Bump json to mashumaro #23

Bump json to mashumaro #23

Uh oh!

Conversation

CoMPaTech commented Jul 22, 2025 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by CodeRabbit

Uh oh!

coderabbitai bot commented Jul 22, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Rate limit exceeded

Walkthrough

Changes

Sequence Diagram(s)

Estimated code review effort

Possibly related PRs

Suggested labels

Poem

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

CoMPaTech commented Jul 22, 2025 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Jul 22, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)