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

Remove pydantic warning manifest #135

Open
wants to merge 5 commits into
base: main
Choose a base branch
from

Conversation

pgoslatara
Copy link

@pgoslatara pgoslatara commented Dec 17, 2024

User description

Re-opens #97 as model_unique_id is still present in manifest v6 through v9 (search results).


PR Type

Bug fix


Description

  • Added model_config = ConfigDict(protected_namespaces=()) to Metric/ParsedMetric classes across manifest versions v6-v9
  • This change prevents Pydantic warnings related to the model_unique_id field in the manifest files
  • Addresses the issue originally raised in Setting namespace to prevent warning #97

Changes walkthrough 📝

Relevant files
Bug fix
manifest_v6.py
Add protected namespace configuration to ParsedMetric       

dbt_artifacts_parser/parsers/manifest/manifest_v6.py

  • Added model_config with protected_namespaces=() to ParsedMetric class
    to prevent Pydantic warnings
  • +2/-0     
    manifest_v7.py
    Add protected namespace configuration to ParsedMetric       

    dbt_artifacts_parser/parsers/manifest/manifest_v7.py

  • Added model_config with protected_namespaces=() to ParsedMetric class
    to prevent Pydantic warnings
  • +2/-0     
    manifest_v8.py
    Add protected namespace configuration to Metric                   

    dbt_artifacts_parser/parsers/manifest/manifest_v8.py

  • Added model_config with protected_namespaces=() to Metric class to
    prevent Pydantic warnings
  • +2/-0     
    manifest_v9.py
    Add protected namespace configuration to Metric                   

    dbt_artifacts_parser/parsers/manifest/manifest_v9.py

  • Added model_config with protected_namespaces=() to Metric class to
    prevent Pydantic warnings
  • +2/-0     

    💡 PR-Agent usage: Comment /help "your question" on any pull request to receive relevant information

    Copy link

    coderabbitai bot commented Dec 17, 2024

    Walkthrough

    The pull request introduces configuration modifications across multiple manifest parser versions (v6 to v9). The primary changes involve adjusting model_config attributes for various classes like ParsedMetric, Metric, CompiledAnalysisNode, and SourceDefinition. These modifications focus on setting protected_namespaces to an empty tuple and configuring extra field handling, which enhances type safety and validation strictness in the data models used for parsing dbt artifacts.

    Changes

    File Change Summary
    dbt_artifacts_parser/parsers/manifest/manifest_v6.py - Updated ParsedMetric with protected_namespaces=()
    - Modified CompiledAnalysisNode to use ResourceType
    - Added quoting field to ParsedSourceDefinition
    dbt_artifacts_parser/parsers/manifest/manifest_v7.py - Added protected_namespaces=() to ParsedMetric
    dbt_artifacts_parser/parsers/manifest/manifest_v8.py - Added protected_namespaces=() to Metric
    - Set extra='forbid' for AnalysisNode
    - Retained extra='forbid' for SourceDefinition
    dbt_artifacts_parser/parsers/manifest/manifest_v9.py - Changed Metric config from extra='forbid' to protected_namespaces=()

    Poem

    🐰 In the realm of dbt's manifest dance,
    Namespaces protected, a rabbit's chance!
    Config tweaks with precision so neat,
    Parsing artifacts, a computational feat!
    Validation's magic, now crystal clear 🔍

    Tip

    CodeRabbit's docstrings feature is now available as part of our Early Access Program! Simply use the command @coderabbitai generate docstrings to have CodeRabbit automatically generate docstrings for your pull request. We would love to hear your feedback on Discord.


    📜 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 ea3b5b2 and 5ce5a81.

    📒 Files selected for processing (4)
    • dbt_artifacts_parser/parsers/manifest/manifest_v6.py (1 hunks)
    • dbt_artifacts_parser/parsers/manifest/manifest_v7.py (1 hunks)
    • dbt_artifacts_parser/parsers/manifest/manifest_v8.py (1 hunks)
    • dbt_artifacts_parser/parsers/manifest/manifest_v9.py (1 hunks)
    ✅ Files skipped from review due to trivial changes (1)
    • dbt_artifacts_parser/parsers/manifest/manifest_v7.py
    🔇 Additional comments (4)
    dbt_artifacts_parser/parsers/manifest/manifest_v8.py (1)

    1085-1086: LGTM: Protected namespaces configuration added to Metric class

    The addition of model_config = ConfigDict(protected_namespaces=()) helps suppress pydantic warnings related to model_unique_id field validation.

    dbt_artifacts_parser/parsers/manifest/manifest_v9.py (1)

    1242-1243: LGTM: Consistent protected namespaces configuration

    The addition of model_config = ConfigDict(protected_namespaces=()) maintains consistency with other manifest versions and helps handle model_unique_id field validation warnings.

    dbt_artifacts_parser/parsers/manifest/manifest_v6.py (2)

    1610-1611: LGTM: Protected namespaces configuration for v6

    The addition of model_config = ConfigDict(protected_namespaces=()) to ParsedMetric maintains consistency with later manifest versions while respecting v6's class structure.


    1610-1611: Verify model_unique_id field usage across manifest versions

    Let's verify the presence and handling of model_unique_id field across manifest versions.

    Also applies to: 1085-1086, 1242-1243

    ✅ Verification successful

    model_unique_id field is consistently defined across manifest versions

    The field model_unique_id is consistently defined as Optional[str] with a default value of None across all manifest versions (v6 through v9), indicating proper handling across versions.

    🏁 Scripts executed

    The following scripts were executed for the analysis:

    Script:

    #!/bin/bash
    # Description: Check for model_unique_id field usage across manifest versions
    
    echo "Checking model_unique_id field usage in manifest parsers..."
    
    # Search for model_unique_id field declarations
    rg -A 2 "model_unique_id: Optional\[str\]" dbt_artifacts_parser/parsers/manifest/
    
    # Search for any other references to model_unique_id
    rg "model_unique_id" dbt_artifacts_parser/parsers/manifest/ --type py
    

    Length of output: 1815


    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 generate docstrings to generate docstrings for this PR. (Beta)
    • @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.

    @pgoslatara pgoslatara marked this pull request as ready for review December 17, 2024 10:57
    @pgoslatara pgoslatara requested a review from yu-iskw as a code owner December 17, 2024 10:57
    Copy link

    Qodo Merge was enabled for this repository. To continue using it, please link your Git account with your Qodo account here.

    PR Reviewer Guide 🔍

    Here are some key observations to aid the review process:

    ⏱️ Estimated effort to review: 1 🔵⚪⚪⚪⚪
    🧪 No relevant tests
    🔒 No security concerns identified
    ⚡ Recommended focus areas for review

    Code Consistency
    Verify that adding protected_namespaces=() to model_config is the correct solution for handling the model_unique_id field warning across all manifest versions

    Copy link

    Qodo Merge was enabled for this repository. To continue using it, please link your Git account with your Qodo account here.

    PR Code Suggestions ✨

    No code suggestions found for the PR.

    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    1 participant