def test_user_with_additional_fields(client: TwitterAPI.TwitterAPI) -> None:
# ref: https://twitter.com/TwitterDev
SAMPLE_USER: Dict = {
# default fields
"id": "2244994945",
"name": "Twitter Dev",
"username": "******",
# additional fields
"created_at": "2013-12-14T04:35:55.000+00:00",
"description": {
"text": "The voice of the #TwitterDev team and your official source for updates, news, and events, related to the #TwitterAPI.",
},
"location": "127.0.0.1",
"url": "https://t.co/3ZX3TNiZCY",
"profile_image_url": "https://pbs.twimg.com/profile_images/1283786620521652229/lEODkLTh_normal.jpg",
"protected": False,
"pinned_tweet_id": "1293593516040269825",
"verified": True,
}
SAMPLE_USER_FIELDS: List[User.Field] = [
User.Field.CREATED_AT,
User.Field.DESCRIPTION,
User.Field.LOCATION,
User.Field.PINNED_TWEET_ID,
User.Field.PROFILE_IMAGE_URL,
User.Field.PROTECTED,
User.Field.URL,
User.Field.VERIFIED,
]
user: User.User = client.get_user_by_id(
SAMPLE_USER["id"], user_fields=SAMPLE_USER_FIELDS
)
assert user.id == SAMPLE_USER["id"], "User ID is wrong."
assert user.name == SAMPLE_USER["name"], "name field is wrong."
assert user.username == SAMPLE_USER["username"], "username field is wrong."
assert user.created_at == datetime.fromisoformat(
SAMPLE_USER["created_at"]
), "created_at is wrong."
assert user.description, "description should exit."
assert (
user.description.text == SAMPLE_USER["description"]["text"]
), "description field is wrong."
assert user.location == SAMPLE_USER["location"], "location field is wrong."
assert (
user.pinned_tweet_id == SAMPLE_USER["pinned_tweet_id"]
), "pinned_tweet_id field is wrong."
assert (
user.profile_image_url == SAMPLE_USER["profile_image_url"]
), "profile_image_url field is wrong."
assert user.protected == SAMPLE_USER["protected"], "protected field is wrong."
assert user.url == SAMPLE_USER["url"], "url field is wrong."
assert user.verified == SAMPLE_USER["verified"], "verified field is wrong."
def test_public_metric_for_user(client: TwitterAPI.TwitterAPI) -> None:
# ref: https://twitter.com/TwitterDev
user: User.User = client.get_user_by_id(
"2244994945", user_fields=[User.Field.PUBLIC_METRICS]
)
assert user.public_metrics, "public_metric should exist."
assert user.public_metrics.followers_count, "followers_count should exist."
assert user.public_metrics.following_count, "following_count should exist."
assert user.public_metrics.tweet_count, "tweet_count should exist."
assert user.public_metrics.listed_count, "listed_count should exist."
def test_get_user_by_id(client: TwitterAPI.TwitterAPI) -> None:
# ref: https://twitter.com/TwitterDev
SAMPLE_USER: Dict = {
"id": "2244994945",
"name": "Twitter Dev",
"username": "******",
}
user: User.User = client.get_user_by_id(SAMPLE_USER["id"])
assert user.id == SAMPLE_USER["id"], "User ID is wrong."
assert user.name == SAMPLE_USER["name"], "name field is wrong."
assert user.username == SAMPLE_USER["username"], "username field is wrong."
def test_not_exist_user_by_id(client: TwitterAPI.TwitterAPI) -> None:
with pytest.raises(Exception):
client.get_user_by_id("")
def test_entities_for_user(client: TwitterAPI.TwitterAPI) -> None:
# ref: https://twitter.com/TwitterDev
SAMPLE_USER: Dict = {
# default fields
"id": "2244994945",
"name": "Twitter Dev",
"username": "******",
# additional fields
"description": {
"text": "The voice of the #TwitterDev team and your official source for updates, news, and events, related to the #TwitterAPI.",
"hashtags": [
{"start": 17, "end": 28, "tag": "TwitterDev"},
{"start": 105, "end": 116, "tag": "TwitterAPI"},
],
},
"url": {
"start": 0,
"end": 23,
"url": "https://t.co/3ZX3TNiZCY",
"expanded_url": "https://developer.twitter.com/en/community",
"display_url": "developer.twitter.com/en/community",
},
}
user: User.User = client.get_user_by_id(
SAMPLE_USER["id"], [User.Field.ENTITIES, User.Field.DESCRIPTION]
)
assert user.id == SAMPLE_USER["id"], "User ID is wrong."
assert user.name == SAMPLE_USER["name"], "name field is wrong."
assert user.username == SAMPLE_USER["username"], "username field is wrong."
# description
assert user.description, "User description should exist."
assert (
user.description.text == SAMPLE_USER["description"]["text"]
), "description's text is wrong."
assert user.description.hashtags, "hashtags should exist."
for idx, hashtag in enumerate(user.description.hashtags):
assert (
hashtag.start == SAMPLE_USER["description"]["hashtags"][idx]["start"]
), f"hashtags[{idx}]: start is wrong."
assert (
hashtag.end == SAMPLE_USER["description"]["hashtags"][idx]["end"]
), f"hashtags[{idx}]: end is wrong."
assert (
hashtag.tag == SAMPLE_USER["description"]["hashtags"][idx]["tag"]
), f"hashtags[{idx}]: tag is wrong."
# url
assert isinstance(user.url, Url), "url's type is wrong"
assert user.url.url == SAMPLE_USER["url"]["url"], "url is wrong."
assert user.url.start == SAMPLE_USER["url"]["start"], "url start is wrong."
assert user.url.end == SAMPLE_USER["url"]["end"], "url end is wrong."
assert (
user.url.expanded_url == SAMPLE_USER["url"]["expanded_url"]
), "expanded_url is wrong."
assert (
user.url.display_url == SAMPLE_USER["url"]["display_url"]
), "display_url is wrong."