Skip to content

Fix KeyError legacy['can_media_tag'] in User class #341

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: main
Choose a base branch
from

Conversation

ruizie
Copy link

@ruizie ruizie commented Mar 28, 2025

Twitter returned data where it caused a KeyError on legacy['can_media_tag'], I do not have the particular test user profile, it was lost.. but I did pass through the same data a second time with this fix and no error occurred ever again.

Summary by Sourcery

Bug Fixes:

  • Fix a KeyError in the User class by using the get method for 'can_media_tag' with a default value of False.

Summary by CodeRabbit

  • Bug Fixes
    • Improved the handling of a user media tagging setting by providing a safe default. This change prevents potential errors when the configuration is missing, ensuring smoother operation.

Copy link

sourcery-ai bot commented Mar 28, 2025

Reviewer's Guide by Sourcery

This pull request addresses a potential KeyError in the User class when the can_media_tag key is missing from the legacy dictionary. It uses the .get() method to safely retrieve the value, providing a default of False if the key is absent.

Updated class diagram for the User class

classDiagram
  class User {
    +verified: bool
    +possibly_sensitive: bool
    +can_dm: bool
    +can_media_tag: bool
    +want_retweets: bool
    +default_profile: bool
    +default_profile_image: bool
  }
  note for User "The can_media_tag attribute is now safely retrieved using .get() with a default value of False."
Loading

File-Level Changes

Change Details Files
Handled the potential absence of the can_media_tag key in the legacy dictionary.
  • Used the .get() method with a default value of False to safely retrieve the value of legacy['can_media_tag'].
  • Avoided a KeyError if the can_media_tag key is not present in the legacy dictionary.
twikit/user.py

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!
  • Generate a plan of action for an issue: Comment @sourcery-ai plan on
    an issue to generate a plan of action for it.

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Copy link
Contributor

coderabbitai bot commented Mar 28, 2025

Walkthrough

The changes update the initialization of the can_media_tag attribute within the User class in the twikit/user.py file. The assignment now uses the .get() method on the legacy dictionary to safely retrieve the value for can_media_tag, defaulting to False if the key is missing. No public entities or declarations were altered.

Changes

File(s) Change Summary
twikit/user.py Modified the initialization of can_media_tag in the User class constructor using legacy.get('can_media_tag', False) instead of direct key access.

Sequence Diagram(s)

sequenceDiagram
    participant L as Legacy Dictionary
    participant U as User Constructor
    U->>L: Retrieve 'can_media_tag' using .get()
    alt Key exists
        L-->>U: Return existing value
    else Key missing
        L-->>U: Return False
    end
Loading

Poem

I'm a hopping rabbit in the code domain,
Skipping errors, easing pain.
The key may hide, but I don't fret—
A default value is set, you bet!
Leaping through logic with a joyful spin,
My changes make the code a win!


📜 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 3818195 and c4b609a.

📒 Files selected for processing (1)
  • twikit/user.py (1 hunks)
🔇 Additional comments (1)
twikit/user.py (1)

109-109: Excellent defensive programming fix!

This change properly handles cases where the Twitter API response doesn't include the 'can_media_tag' key in the legacy dictionary. Using the .get() method with a default value of False prevents the KeyError described in the PR and is consistent with how other similar attributes (like protected, profile_banner_url, etc.) are handled throughout this class.

✨ Finishing Touches
  • 📝 Generate Docstrings

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.
    • 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.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai plan to trigger planning for file edits and PR creation.
  • @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

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

Hey @ruizie - I've reviewed your changes - here's some feedback:

Overall Comments:

  • Consider adding a default value to other legacy[...] calls to avoid similar issues.
Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟢 Documentation: all looks good

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

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.

1 participant