twikit icon indicating copy to clipboard operation
twikit copied to clipboard

Fix check for screen name when building friendships request for V11 client class

Open sarartur opened this issue 1 year ago • 2 comments

What

Adjust how the payload is created when fetching friendships

Why

Current implementation does not build the payload correctly. The screen_name is set even if not provided and is not set unless user_id is provided.

Details

The check https://github.com/d60/twikit/blob/6d19016f7809dc0458994e1504edb7de3ae57504/twikit/client/v11.py#L389 should be checking for presence of screen_name and not user_id since we are setting the screen_name when the condition is met https://github.com/d60/twikit/blob/6d19016f7809dc0458994e1504edb7de3ae57504/twikit/client/v11.py#L390

Summary by Sourcery

Fix the logic for constructing the payload in the friendships request by ensuring the 'screen_name' is correctly checked and included when 'user_id' is not provided.

Bug Fixes:

  • Correct the condition to check for the presence of 'screen_name' instead of 'user_id' when building the payload for fetching friendships.

Summary by CodeRabbit

  • Bug Fixes
    • Improved the logic for setting the screen_name parameter, ensuring it is only set when explicitly provided, enhancing the function's clarity and control flow.

sarartur avatar Sep 09 '24 21:09 sarartur

Reviewer's Guide by Sourcery

This pull request fixes a bug in the _friendships method of the V11 client class. The change corrects the condition for including the screen_name parameter in the API request payload, ensuring that screen_name is properly used when user_id is not provided.

File-Level Changes

Change Details Files
Fix condition for including screen_name in friendships request payload
  • Change condition from 'elif user_id is not None' to 'elif screen_name is not None'
  • Ensure screen_name is included in params when user_id is not provided
twikit/client/v11.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.

sourcery-ai[bot] avatar Sep 09 '24 21:09 sourcery-ai[bot]

Walkthrough

The changes involve modifications to the _friendships asynchronous function in the twikit/client/v11.py file. The logic for setting the screen_name parameter in the params dictionary has been updated to eliminate a redundant check for user_id. The new implementation ensures that screen_name is only set when it is explicitly provided, enhancing the clarity of the function's logic.

Changes

Files Change Summary
twikit/client/v11.py Modified the _friendships function to replace a redundant check for screen_name with a condition that checks if screen_name is not None.

Poem

In the code where rabbits play,
A check was changed, hip-hip-hooray!
Now screen_name shines so bright,
Only set when it feels right.
Hopping through the logic clear,
We celebrate with joyful cheer! 🐇✨

[!TIP]

New review model

We have updated our review workflow to use the Anthropic's Claude family of models. Please share any feedback in the discussion post on our Discord.


New features

Walkthrough comment now includes:

  • Possibly related PRs: A list of potentially related PRs to help you recall past context.
  • Suggested labels: CodeRabbit can now suggest labels by learning from your past PRs. You can also provide custom labeling instructions in the UI or configuration file.

Notes:

  • Please share any feedback in the discussion post on our Discord.
  • Possibly related PRs, automatic label suggestions based on past PRs, learnings, and possibly related issues require data opt-in (enabled by default).

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

coderabbitai[bot] avatar Sep 09 '24 21:09 coderabbitai[bot]