Skip to content

Finalize typing on ctl.schema #451

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

Open
wants to merge 1 commit into
base: develop
Choose a base branch
from

Conversation

ogenstad
Copy link
Contributor

@ogenstad ogenstad commented Jun 21, 2025

Summary by CodeRabbit

  • Refactor

    • Unified schema data access by consistently using the payload attribute, enhancing internal consistency and type annotations.
  • Chores

    • Improved type annotations for clarity.
    • Enabled stricter type checking for schema-related code through configuration updates.

Copy link

codecov bot commented Jun 21, 2025

Codecov Report

❌ Patch coverage is 55.55556% with 4 lines in your changes missing coverage. Please review.

Files with missing lines Patch % Lines
infrahub_sdk/ctl/schema.py 55.55% 3 Missing and 1 partial ⚠️
@@           Coverage Diff            @@
##           develop     #451   +/-   ##
========================================
  Coverage    75.56%   75.56%           
========================================
  Files          100      100           
  Lines         8790     8790           
  Branches      1716     1716           
========================================
  Hits          6642     6642           
  Misses        1669     1669           
  Partials       479      479           
Flag Coverage Δ
integration-tests 34.57% <22.22%> (-0.02%) ⬇️
python-3.10 47.97% <55.55%> (ø)
python-3.11 47.97% <55.55%> (ø)
python-3.12 47.95% <55.55%> (+0.02%) ⬆️
python-3.13 47.92% <55.55%> (-0.03%) ⬇️
python-3.9 46.64% <55.55%> (ø)
python-filler-3.12 25.17% <0.00%> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

Files with missing lines Coverage Δ
infrahub_sdk/ctl/schema.py 55.83% <55.55%> (ø)
🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@dgarros dgarros marked this pull request as ready for review July 22, 2025 20:11
Copy link

coderabbitai bot commented Jul 22, 2025

Walkthrough

References to the .content attribute of SchemaFile objects in infrahub_sdk/ctl/schema.py have been replaced with .payload for schema data access. Type annotations for functions handling schema data have been updated to use SchemaFile. The mypy configuration override for this module was removed from pyproject.toml.

Changes

Cohort / File(s) Change Summary
Schema Data Access and Type Annotations
infrahub_sdk/ctl/schema.py
Replaced .content with .payload for schema data access; updated function parameter type annotations to use SchemaFile; minor logic adjustments for error handling.
Mypy Configuration
pyproject.toml
Removed mypy override block for infrahub_sdk.ctl.schema that previously disabled specific error codes.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~7 minutes

Note

⚡️ Unit Test Generation is now available in beta!

Learn more here, or try it out under "Finishing Touches" below.


📜 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 a47231e and 8e357b9.

📒 Files selected for processing (2)
  • infrahub_sdk/ctl/schema.py (6 hunks)
  • pyproject.toml (0 hunks)
💤 Files with no reviewable changes (1)
  • pyproject.toml
🚧 Files skipped from review as they are similar to previous changes (1)
  • infrahub_sdk/ctl/schema.py
⏰ 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). (6)
  • GitHub Check: unit-tests (3.13)
  • GitHub Check: unit-tests (3.10)
  • GitHub Check: unit-tests (3.9)
  • GitHub Check: unit-tests (3.11)
  • GitHub Check: unit-tests (3.12)
  • GitHub Check: Cloudflare Pages
✨ Finishing Touches
  • 📝 Generate Docstrings
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch pog-ctl-schema-typing-20250620

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

@BeArchiTek
Copy link
Contributor

@coderabbitai review

Copy link

coderabbitai bot commented Jul 28, 2025

✅ Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

@ogenstad ogenstad force-pushed the pog-ctl-schema-typing-20250620 branch from a47231e to 8e357b9 Compare July 28, 2025 07:43
Copy link

@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

🧹 Nitpick comments (1)
infrahub_sdk/ctl/schema.py (1)

176-176: Good defensive programming with null safety.

The response or {} pattern provides a safe fallback when response might be None, preventing potential issues in display_schema_load_errors.

Consider adding test coverage for this edge case where response could be None, as indicated by the static analysis warning.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 91a828a and a47231e.

📒 Files selected for processing (2)
  • infrahub_sdk/ctl/schema.py (6 hunks)
  • pyproject.toml (0 hunks)
💤 Files with no reviewable changes (1)
  • pyproject.toml
🧰 Additional context used
🪛 GitHub Check: codecov/patch
infrahub_sdk/ctl/schema.py

[warning] 176-176: infrahub_sdk/ctl/schema.py#L176
Added line #L176 was not covered by tests

🔇 Additional comments (6)
infrahub_sdk/ctl/schema.py (6)

39-39: LGTM! Consistent attribute access.

The change from .content to .payload aligns with the SchemaFile interface and improves consistency across the codebase.


51-51: Excellent type safety improvement.

Updated the parameter type from list[dict] to list[SchemaFile] which provides better type checking and aligns with the actual usage in the function.


90-90: Direct dictionary access is safe in this context.

The change from .get("errors") to ["errors"] is appropriate since the elif "errors" in response condition above guarantees the key exists.


100-102: Consistent typing and attribute access improvements.

The function signature now properly types the parameter as list[SchemaFile] and consistently uses .payload to access schema data. These changes improve type safety and maintain consistency with the SchemaFile interface.


125-125: Consistent payload access in load function.

The change from .content to .payload maintains consistency with the SchemaFile interface refactoring throughout the module.


173-173: Consistent payload access in check function.

The change from .content to .payload follows the same pattern as other functions and maintains consistency with the SchemaFile interface.

Copy link

cloudflare-workers-and-pages bot commented Jul 28, 2025

Deploying infrahub-sdk-python with  Cloudflare Pages  Cloudflare Pages

Latest commit: 8e357b9
Status: ✅  Deploy successful!
Preview URL: https://40ccd39f.infrahub-sdk-python.pages.dev
Branch Preview URL: https://pog-ctl-schema-typing-202506.infrahub-sdk-python.pages.dev

View logs

@ogenstad ogenstad requested a review from a team July 28, 2025 10:56
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.

3 participants