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

implemented error handling using twitter response code #29

Merged
merged 3 commits into from
Feb 14, 2024

Conversation

HeIIow2
Copy link
Contributor

@HeIIow2 HeIIow2 commented Feb 14, 2024

Summary by CodeRabbit

  • New Features
    • Introduced error handling in tweet creation to manage duplicate tweets and other errors more effectively.
  • Bug Fixes
    • Improved exception raising for situations where tweets cannot be processed due to various errors.

Copy link
Contributor

coderabbitai bot commented Feb 14, 2024

Warning

Rate Limit Exceeded

@HeIIow2 has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 20 minutes and 18 seconds before requesting another review.

How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.
Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.
Please see our FAQ for further information.

Commits Files that changed from the base of the PR and between 9afcd37 and 8aad908.

Walkthrough

These updates improve error handling in a Twitter toolkit by introducing specific exceptions for common issues like duplicate tweets and generic tweeting failures. The changes ensure that errors are not just logged but are actively managed by raising exceptions when certain conditions are met, enhancing the robustness and usability of the toolkit.

Changes

File Summary
twikit/client.py - Added support for raising exceptions for duplicate tweets and other errors.
twikit/errors.py - Introduced new exceptions and a mapping for error codes to streamline exception handling.

🐇✨
In the code's deep burrow, under the digital sky,
A rabbit worked hard, as the bits flew by.
With a hop and a skip, errors now in check,
No more duplicates, a smooth deck.
"To better tweets," it whispered, with glee,
For a bug-free world, as far as the eye can see.
🌟🐾

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-tests for this file.
  • 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 tests 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 from git and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit tests.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

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 a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

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

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • The JSON schema for the configuration file is available here.
  • 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/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

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.

Review Status

Actionable comments generated: 3

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between d097649 and 9afcd37.
Files selected for processing (2)
  • twikit/client.py (3 hunks)
  • twikit/errors.py (2 hunks)
Additional comments: 3
twikit/errors.py (1)
  • 45-58: The implementation of CouldNotTweet and DuplicateTweet exceptions is correct and follows Python's exception handling conventions.
twikit/client.py (2)
  • 693-696: The documentation for the DuplicateTweet exception is clear, but ensure that the actual logic to detect and raise this exception based on Twitter's response codes is implemented within the create_tweet method or the raise_exceptions_from_response function.
  • 776-780: The use of raise_exceptions_from_response to handle errors based on Twitter's response codes is a good implementation. However, ensure that all possible Twitter API errors are mapped correctly in the ERROR_CODE_TO_EXCEPTION mapping to avoid unhandled exceptions.

twikit/errors.py Show resolved Hide resolved
Comment on lines +66 to +102
def raise_exceptions_from_response(error_list: List[dict]):
"""
This works assuming that the error codes are in:
- error['code']
- error['extensions']['code']

this is an example of one error (returned on a duplicate tweet error):
{
'message': 'Authorization: Status is a duplicate. (187)',
'locations': [{'line': 18, 'column': 3}],
'path': ['create_tweet'],
'extensions': {
'name': 'AuthorizationError',
'source': 'Client',
'code': 187,
'kind': 'Permissions',
'tracing': {'trace_id': '...'}
},
'code': 187,
'kind': 'Permissions',
'name': 'AuthorizationError',
'source': 'Client',
'tracing': {'trace_id': '...'}
}
"""
global ERROR_CODE_TO_EXCEPTION

for error in error_list:
# getting the error code from either ['code'] or []'extensions']['code']
code = error.get('code')
if code not in ERROR_CODE_TO_EXCEPTION:
code = error.get('extensions', {}).get('code')

exception = ERROR_CODE_TO_EXCEPTION[code]

if exception is not None:
raise exception(error)
Copy link
Contributor

Choose a reason for hiding this comment

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

  • The function raise_exceptions_from_response correctly iterates over the error list and attempts to raise exceptions based on the error codes. However, it lacks error handling for cases where the error code does not exist in the ERROR_CODE_TO_EXCEPTION mapping or when the error structure does not match the expected format. This could lead to KeyError or TypeError.
  • The use of global ERROR_CODE_TO_EXCEPTION is unnecessary since ERROR_CODE_TO_EXCEPTION is not being modified, only accessed.
- global ERROR_CODE_TO_EXCEPTION
+ # Removed unnecessary global declaration

Consider adding error handling for unexpected error structures and ensure that the function does not raise unexpected exceptions.


Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.

Suggested change
def raise_exceptions_from_response(error_list: List[dict]):
"""
This works assuming that the error codes are in:
- error['code']
- error['extensions']['code']
this is an example of one error (returned on a duplicate tweet error):
{
'message': 'Authorization: Status is a duplicate. (187)',
'locations': [{'line': 18, 'column': 3}],
'path': ['create_tweet'],
'extensions': {
'name': 'AuthorizationError',
'source': 'Client',
'code': 187,
'kind': 'Permissions',
'tracing': {'trace_id': '...'}
},
'code': 187,
'kind': 'Permissions',
'name': 'AuthorizationError',
'source': 'Client',
'tracing': {'trace_id': '...'}
}
"""
global ERROR_CODE_TO_EXCEPTION
for error in error_list:
# getting the error code from either ['code'] or []'extensions']['code']
code = error.get('code')
if code not in ERROR_CODE_TO_EXCEPTION:
code = error.get('extensions', {}).get('code')
exception = ERROR_CODE_TO_EXCEPTION[code]
if exception is not None:
raise exception(error)
def raise_exceptions_from_response(error_list: List[dict]):
"""
This works assuming that the error codes are in:
- error['code']
- error['extensions']['code']
this is an example of one error (returned on a duplicate tweet error):
{
'message': 'Authorization: Status is a duplicate. (187)',
'locations': [{'line': 18, 'column': 3}],
'path': ['create_tweet'],
'extensions': {
'name': 'AuthorizationError',
'source': 'Client',
'code': 187,
'kind': 'Permissions',
'tracing': {'trace_id': '...'}
},
'code': 187,
'kind': 'Permissions',
'name': 'AuthorizationError',
'source': 'Client',
'tracing': {'trace_id': '...'}
}
"""
# Removed unnecessary global declaration
for error in error_list:
# getting the error code from either ['code'] or []'extensions']['code']
code = error.get('code')
if code not in ERROR_CODE_TO_EXCEPTION:
code = error.get('extensions', {}).get('code')
exception = ERROR_CODE_TO_EXCEPTION.get(code)
if exception is not None:
raise exception(error)

twikit/client.py Outdated
@@ -26,6 +26,7 @@
get_query_id,
urlencode
)
from .errors import raise_exceptions_from_response
Copy link
Contributor

Choose a reason for hiding this comment

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

Missing error handling for the import of raise_exceptions_from_response. Ensure that there's a fallback or error message if the import fails due to the function not being available in .errors.

@d60 d60 merged commit aee8c8a into d60:main Feb 14, 2024
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.

None yet

2 participants