Spaces:
Sleeping
Sleeping
File size: 12,505 Bytes
4d1746c |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 |
from copy import deepcopy
from typing import Dict, List, Optional, Union
DEFAULT_STATE = {
"username": "john",
"password": "john123",
"authenticated": False,
"tweets": {},
"comments": {},
"retweets": {},
"following_list": ["alice", "bob"],
"tweet_counter": 0,
}
class TwitterAPI:
def __init__(self):
self.username: str
self.password: str
self.authenticated: bool
self.tweets: Dict[int, Dict[str, Union[int, str, List[str]]]]
self.comments: Dict[int, List[Dict[str, str]]]
self.retweets: Dict[str, List[int]]
self.following_list: List[str]
# tweet_counter is used to assign unique IDs to tweets, it might not be the same as the length of the tweets list for different scenarios
self.tweet_counter: int
self._api_description = "This tool belongs to the TwitterAPI, which provides core functionality for posting tweets, retweeting, commenting, and following users on Twitter."
def _load_scenario(self, scenario: dict, long_context=False) -> None:
"""
Load a scenario into the TwitterAPI instance.
Args:
scenario (dict): A dictionary containing Twitter data.
"""
DEFAULT_STATE_COPY = deepcopy(DEFAULT_STATE)
self.username = scenario.get("username", DEFAULT_STATE_COPY["username"])
self.password = scenario.get("password", DEFAULT_STATE_COPY["password"])
self.authenticated = scenario.get(
"authenticated", DEFAULT_STATE_COPY["authenticated"]
)
self.tweets = scenario.get("tweets", DEFAULT_STATE_COPY["tweets"])
self.tweets = {int(k): v for k, v in self.tweets.items()} # Convert tweet keys from string to int from loaded scenario
self.comments = scenario.get("comments", DEFAULT_STATE_COPY["comments"])
self.retweets = scenario.get("retweets", DEFAULT_STATE_COPY["retweets"])
self.following_list = scenario.get(
"following_list", DEFAULT_STATE_COPY["following_list"]
)
self.tweet_counter = scenario.get(
"tweet_counter", DEFAULT_STATE_COPY["tweet_counter"]
)
def authenticate_twitter(self, username: str, password: str) -> Dict[str, bool]:
"""
Authenticate a user with username and password.
Args:
username (str): Username of the user.
password (str): Password of the user.
Returns:
authentication_status (bool): True if authenticated, False otherwise.
"""
if username == self.username and password == self.password:
self.authenticated = True
return {"authentication_status": True}
return {"authentication_status": False}
def posting_get_login_status(self) -> Dict[str, Union[bool, str]]:
"""
Get the login status of the current user.
Returns:
login_status (bool): True if the current user is logged in, False otherwise.
"""
return {"login_status": bool(self.authenticated)}
def post_tweet(
self, content: str, tags: List[str] = [], mentions: List[str] = []
) -> Dict[str, Union[int, str, List[str]]]:
"""
Post a tweet for the authenticated user.
Args:
content (str): Content of the tweet.
tags (List[str]): [Optional] List of tags for the tweet. Tag name should start with #. This is only relevant if the user wants to add tags to the tweet.
mentions (List[str]): [Optional] List of users mentioned in the tweet. Mention name should start with @. This is only relevant if the user wants to add mentions to the tweet.
Returns:
id (int): ID of the posted tweet.
username (str): Username of the poster.
content (str): Content of the tweet.
tags (List[str]): List of tags associated with the tweet.
mentions (List[str]): List of users mentioned in the tweet.
"""
if not self.authenticated:
return {"error": "User not authenticated. Please authenticate before posting."}
tweet = {
"id": self.tweet_counter,
"username": self.username,
"content": content,
"tags": tags,
"mentions": mentions,
}
self.tweets[self.tweet_counter] = tweet
self.tweet_counter += 1
return tweet
def retweet(self, tweet_id: int) -> Dict[str, str]:
"""
Retweet a tweet for the authenticated user.
Args:
tweet_id (int): ID of the tweet to retweet.
Returns:
retweet_status (str): Status of the retweet action.
"""
if not self.authenticated:
return {"error": "User not authenticated. Please authenticate before retweeting."}
if tweet_id not in self.tweets:
return {"error": f"Tweet with ID {tweet_id} not found."}
if self.username not in self.retweets:
self.retweets[self.username] = []
if tweet_id in self.retweets[self.username]:
return {"retweet_status": "Already retweeted"}
self.retweets[self.username].append(tweet_id)
return {"retweet_status": "Successfully retweeted"}
def comment(self, tweet_id: int, comment_content: str) -> Dict[str, str]:
"""
Comment on a tweet for the authenticated user.
Args:
tweet_id (int): ID of the tweet to comment on.
comment_content (str): Content of the comment.
Returns:
comment_status (str): Status of the comment action.
"""
if not self.authenticated:
raise {"error": "User not authenticated. Please authenticate before commenting."}
if tweet_id not in self.tweets:
return {"error": f"Tweet with ID {tweet_id} not found."}
if tweet_id not in self.comments:
self.comments[tweet_id] = []
self.comments[tweet_id].append(
{"username": self.username, "content": comment_content}
)
return {"comment_status": "Comment added successfully"}
def mention(self, tweet_id: int, mentioned_usernames: List[str]) -> Dict[str, str]:
"""
Mention specified users in a tweet.
Args:
tweet_id (int): ID of the tweet where users are mentioned.
mentioned_usernames (List[str]): List of usernames to be mentioned.
Returns:
mention_status (str): Status of the mention action.
"""
if tweet_id not in self.tweets:
return {"error": f"Tweet with ID {tweet_id} not found."}
tweet = self.tweets[tweet_id]
tweet["mentions"].extend(mentioned_usernames)
return {"mention_status": "Users mentioned successfully"}
def follow_user(self, username_to_follow: str) -> Dict[str, bool]:
"""
Follow a user for the authenticated user.
Args:
username_to_follow (str): Username of the user to follow.
Returns:
follow_status (bool): True if followed, False if already following.
"""
if not self.authenticated:
return {"error": "User not authenticated. Please authenticate before following."}
if username_to_follow in self.following_list:
return {"follow_status": False}
self.following_list.append(username_to_follow)
return {"follow_status": True}
def list_all_following(self) -> List[str]:
"""
List all users that the authenticated user is following.
Returns:
following_list (List[str]): List of all users that the authenticated user is following.
"""
if not self.authenticated:
return {"error": "User not authenticated. Please authenticate before listing following."}
return self.following_list
def unfollow_user(self, username_to_unfollow: str) -> Dict[str, bool]:
"""
Unfollow a user for the authenticated user.
Args:
username_to_unfollow (str): Username of the user to unfollow.
Returns:
unfollow_status (bool): True if unfollowed, False if not following.
"""
if not self.authenticated:
return {"error": "User not authenticated. Please authenticate before unfollowing."}
if username_to_unfollow not in self.following_list:
return {"unfollow_status": False}
self.following_list.remove(username_to_unfollow)
return {"unfollow_status": True}
def get_tweet(self, tweet_id: int) -> Dict[str, Union[int, str, List[str]]]:
"""
Retrieve a specific tweet.
Args:
tweet_id (int): ID of the tweet to retrieve.
Returns:
id (int): ID of the retrieved tweet.
username (str): Username of the tweet's author.
content (str): Content of the tweet.
tags (List[str]): List of tags associated with the tweet.
mentions (List[str]): List of users mentioned in the tweet.
"""
if tweet_id not in self.tweets:
return {"error": f"Tweet with ID {tweet_id} not found."}
return self.tweets[tweet_id]
def get_user_tweets(self, username: str) -> List[Dict[str, Union[int, str, List[str]]]]:
"""
Retrieve all tweets from a specific user.
Args:
username (str): Username of the user whose tweets to retrieve.
Returns:
user_tweets (List[Dict]): List of dictionaries, each containing tweet information.
- id (int): ID of the retrieved tweet.
- username (str): Username of the tweet's author.
- content (str): Content of the tweet.
- tags (List[str]): List of tags associated with the tweet.
- mentions (List[str]): List of users mentioned in the tweet.
"""
return [tweet for tweet in self.tweets.values() if tweet["username"] == username]
def search_tweets(self, keyword: str) -> List[Dict[str, Union[int, str, List[str]]]]:
"""
Search for tweets containing a specific keyword.
Args:
keyword (str): Keyword to search for in the content of the tweets.
Returns:
matching_tweets (List[Dict]): List of dictionaries, each containing tweet information.
- id (int): ID of the retrieved tweet.
- username (str): Username of the tweet's author.
- content (str): Content of the tweet.
- tags (List[str]): List of tags associated with the tweet.
- mentions (List[str]): List of users mentioned in the tweet.
"""
return [
tweet
for tweet in self.tweets.values()
if keyword.lower() in tweet["content"].lower()
or keyword.lower() in [tag.lower() for tag in tweet["tags"]]
]
def get_tweet_comments(self, tweet_id: int) -> List[Dict[str, str]]:
"""
Retrieve all comments for a specific tweet.
Args:
tweet_id (int): ID of the tweet to retrieve comments for.
Returns:
comments (List[Dict]): List of dictionaries, each containing comment information.
- username (str): Username of the commenter.
- content (str): Content of the comment.
"""
if tweet_id not in self.tweets:
return {"error": f"Tweet with ID {tweet_id} not found."}
return self.comments.get(tweet_id, [])
def get_user_stats(self, username: str) -> Dict[str, int]:
"""
Get statistics for a specific user.
Args:
username (str): Username of the user to get statistics for.
Returns:
tweet_count (int): Number of tweets posted by the user.
following_count (int): Number of users the specified user is following.
retweet_count (int): Number of retweets made by the user.
"""
tweet_count = len(
[tweet for tweet in self.tweets.values() if tweet["username"] == username]
)
following_count = len(self.following_list) if username == self.username else 0
retweet_count = len(self.retweets.get(username, []))
return {
"tweet_count": tweet_count,
"following_count": following_count,
"retweet_count": retweet_count,
}
|