store response headers at each requests

[bdelpey]

resolve issue #252

The goal is to be able to track 'x-rate-limit-remaining' and 'x-rate-limit-reset' when retrieving a lot of tweets to avoid getting TooManyRequests exception.

Summary by Sourcery

Bug Fixes:

• Resolve issue #252 by storing response headers, enabling tracking of rate limit information such as "x-rate-limit-remaining" and "x-rate-limit-reset" to prevent TooManyRequests exceptions.

Summary by CodeRabbit

• Chores
  • Enhanced management of network interactions by refining response processing for improved diagnostic support and overall system reliability.
  • Implemented backend improvements to ensure a robust and stable environment while maintaining a seamless, uninterrupted user experience.
  • This foundational update bolsters internal capacity for enhanced performance and scalability, laying the groundwork for future improvements.

[sourcery-ai[bot]]

Reviewer's Guide by Sourcery

This PR addresses issue #252 by introducing a new mechanism to store response headers, particularly for tracking rate limit values. The implementation adds a new attribute to the client to hold the header information and updates it when a request is made.

Updated Class Diagram for Client with Response Headers

classDiagram
    class Client {
      - _user_id
      - _user_agent
      - _act_as
      - _response_headers
      + __init__(...)
      + request(...)
    }
    note for Client "New attribute _response_headers is added to track response headers for rate limiting."

File-Level Changes

Change	Details	Files
Introduce response header tracking within the client.	Added a new attribute to initialize response headers in the constructor. Updated the request method to capture and store response headers from the HTTP response.	twikit/client/client.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

• Contact our support team for questions or feedback.
• Visit our documentation for detailed guides and information.
• Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

[coderabbitai[bot]]

Walkthrough

A new private attribute _response_headers has been added to the Client class in the twikit/client/client.py file. The constructor now initializes _response_headers to None, and the request method updates this attribute with the HTTP response headers after the request is executed. These changes augment the class by providing a way to capture and retain HTTP response header information without altering the existing functionality.

Changes

File	Change Summary
twikit/.../client.py	Added private attribute _response_headers to Client (initialized in __init__) and updated the request method to store HTTP response headers.

Sequence Diagram(s)

sequenceDiagram
    participant C as Client
    participant S as HTTP Server

    C->>S: Execute HTTP request
    S-->>C: Return response (with headers)
    C->>C: Set _response_headers attribute with response headers

Poem

I'm a little rabbit in the code,
Hoping where headers unload,
New changes bloom in every byte,
Making API calls feel just right.
With a twitch of my nose and a gleeful grin,
I skip along where fixes begin!

✨ Finishing Touches

• [ ] 📝 Generate Docstrings (Beta)

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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

[bdelpey]

@bdelpey Hi, Can you give exsampel how to use this? I install it but how to get rate limit values?

You can get all the last response headers like that : client._response_headers Note that if the client have not done any requests, this value is None

For example to store all the tweets of a particular user :

tweets_to_store = []
tweets = await user.get_tweets('Tweets')

tweets_to_store.extend(tweets)

while True:
    if int(client._response_headers['x-rate-limit-remaining']) > 0 or int(client._response_headers['x-rate-limit-reset']) < int(time.time()):       
        tweets = await tweets.next()
        if not tweets: break
        tweets_to_store.extend(tweets)
    time.sleep(5)

[TheCrazyLex]

@d60 Something like this would be truly great! Getting the rate limit headers on non-error requests would be a winner