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

bug when calling get_dm_history with someone you have no entries with #190

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

Conversation

shubh9
Copy link

@shubh9 shubh9 commented Aug 28, 2024

Summary by Sourcery

Fix the bug in get_dm_history by ensuring the function checks for the presence of 'entries' in the response before attempting to access them, preventing errors when there are no entries.

Bug Fixes:

  • Fix the bug in get_dm_history where an error occurs if there are no entries with a user by checking for the presence of 'entries' in the response before accessing them.

Summary by CodeRabbit

  • Bug Fixes
    • Improved error handling in the direct message history retrieval function, preventing runtime errors when accessing potentially missing data.

Copy link
Contributor

coderabbitai bot commented Aug 28, 2024

Walkthrough

The change involves modifying the get_dm_history asynchronous function in the twikit/client/client.py file. The reassignment of the items variable is now contingent upon the presence of the 'entries' key in the response['conversation_timeline']. This adjustment prevents potential KeyErrors and enhances error handling in the function.

Changes

Files Change Summary
twikit/client/client.py Modified get_dm_history to conditionally assign items based on the existence of the 'entries' key.

Poem

🐇 In the code where rabbits hop,
A check for entries, now no flop!
With items safe, we dance and play,
No more errors spoil the day!
Hooray for changes, bright and neat,
In the world of code, we’re quick on our feet! 🌟


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>.
    • 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 generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @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 as 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 resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

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 bot commented Aug 28, 2024

Reviewer's Guide by Sourcery

This pull request addresses a bug in the get_dm_history function where it would fail when called with a user who has no DM history entries. The fix involves reordering the code to check for the existence of 'entries' in the response before attempting to access it.

File-Level Changes

Change Details Files
Reordered code to check for 'entries' in response before accessing it
  • Moved the check for 'entries' in response['conversation_timeline'] before assigning to 'items'
  • Moved the assignment of 'items' after the existence check
twikit/client/client.py

Tips
  • Trigger a new Sourcery review by commenting @sourcery-ai review on the pull request.
  • Continue your discussion with Sourcery by replying directly to review comments.
  • You can change your review settings at any time by accessing your dashboard:
    • Enable or disable the Sourcery-generated pull request summary or reviewer's guide;
    • Change the review language;
  • You can always contact us if you have any questions or feedback.

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 @shubh9 - I've reviewed your changes and they look great!

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 to tell me if it was helpful.

Copy link
Contributor

@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

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 6d19016 and 8b58b3c.

Files selected for processing (1)
  • twikit/client/client.py (1 hunks)
Additional comments not posted (1)
twikit/client/client.py (1)

3041-3042: Enhance error handling by checking for 'entries' key.

The reassignment of the items variable is now contingent upon the presence of the 'entries' key in the response['conversation_timeline']. This prevents potential KeyErrors and enhances error handling.

The code changes are approved.

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