twitter-openapi-python 0.1.0__py3-none-any.whl → 0.1.2__py3-none-any.whl

twitter_openapi_python/api/users_api.py

@@ -7,6 +7,7 @@ from x_client_transaction import ClientTransaction
 from twitter_openapi_python.models import TwitterApiUtilsResponse, UserApiUtilsData
 from twitter_openapi_python.utils import (
     build_response,
+    data_request,
     error_check,
     get_kwargs,
     user_result_converter,
@@ -54,3 +55,20 @@ class UsersApiUtils:
             key="UsersByRestIds",
             param=param,
         )
+
+    def get_users_verified_avatars(
+        self,
+        user_ids: list[str],
+        extra_param: Optional[ParamType] = None,
+    ) -> TwitterApiUtilsResponse[list[models.VerifiedAvatarUser]]:
+        """Partial users (avatar shape, verification) for the given ids."""
+        param: ParamType = {"userIds": user_ids}
+        if extra_param is not None:
+            param.update(extra_param)
+        return data_request(
+            self.api.get_users_verified_avatars_with_http_info,
+            self.flag["UsersVerifiedAvatars"],
+            self.ct,
+            lambda e: [x.result for x in error_check(e.data, e.errors).users_results],
+            param,
+        )

twitter_openapi_python/client.py

@@ -8,6 +8,8 @@ import urllib3
 from x_client_transaction import ClientTransaction
 
 from twitter_openapi_python.api import (
+    BirdwatchApiUtils,
+    CommunityApiUtils,
     DefaultApiUtils,
     InitialStateApiUtils,
     PostApiUtils,
@@ -32,6 +34,12 @@ class TwitterOpenapiPythonClient:
         self.placeholder = placeholder
         self.ct = ct
 
+    def get_birdwatch_api(self) -> BirdwatchApiUtils:
+        return BirdwatchApiUtils(twitter.BirdwatchApi(self.api), self.placeholder, self.ct)
+
+    def get_community_api(self) -> CommunityApiUtils:
+        return CommunityApiUtils(twitter.CommunityApi(self.api), self.placeholder, self.ct)
+
     def get_default_api(self) -> DefaultApiUtils:
         return DefaultApiUtils(twitter.DefaultApi(self.api), self.placeholder, self.ct)
 
@@ -61,7 +69,7 @@ class TwitterOpenapiPythonClient:
 
 
 class TwitterOpenapiPython:
-    hash: str = "103dca20cc540be8dc8291e6f573c3d48ba7af3e"
+    hash: str = "127fa210d7f9b0252276c86a1860a7db816d9d69"
     placeholder_url = "https://raw.githubusercontent.com/fa0311/twitter-openapi/{hash}/src/config/placeholder.json"
     header = "https://raw.githubusercontent.com/fa0311/latest-user-agent/refs/heads/main/header.json"
     access_token: str = (

twitter_openapi_python/models/__init__.py

@@ -15,6 +15,7 @@ from twitter_openapi_python.models.response import (
 )
 from twitter_openapi_python.models.timeline import (
     ApiUtilsRaw,
+    CommunityApiUtilsData,
     CursorApiUtilsResponse,
     TimelineApiUtilsResponse,
     TweetApiUtilsData,

twitter_openapi_python/models/timeline.py

@@ -34,6 +34,11 @@ class UserApiUtilsData(BaseModel):
     user: models.User = Field()
 
 
+class CommunityApiUtilsData(BaseModel):
+    raw: models.TimelineCommunity = Field()
+    community: models.Community = Field()
+
+
 class TimelineApiUtilsResponse(BaseModel, Generic[T]):
     raw: ApiUtilsRaw = Field()
     cursor: CursorApiUtilsResponse = Field()

twitter_openapi_python/utils/__init__.py

@@ -8,11 +8,18 @@ from twitter_openapi_python.utils.api import (
     build_header,
     build_response,
     build_tweet_api_utils,
+    community_entries_converter,
+    data_request,
     error_check,
     entries_cursor,
     get_kwargs,
     get_legacy_kwargs,
     instruction_to_entry,
+    item_contents,
+    list_entries_converter,
+    notification_entries_converter,
+    timeline_request,
+    trend_entries_converter,
     tweet_entries_converter,
     tweet_results_converter,
     user_entries_converter,

twitter_openapi_python/utils/api.py

@@ -1,5 +1,5 @@
 import json
-from typing import Any, Dict, List, Mapping, Optional, TypeGuard, TypeVar
+from typing import Any, Callable, Dict, List, Mapping, Optional, TypeGuard, TypeVar
 
 import twitter_openapi_python_generated as twitter
 import twitter_openapi_python_generated.models as models
@@ -7,7 +7,10 @@ from x_client_transaction import ClientTransaction
 
 from twitter_openapi_python.models import (
     ApiUtilsHeader,
+    ApiUtilsRaw,
+    CommunityApiUtilsData,
     CursorApiUtilsResponse,
+    TimelineApiUtilsResponse,
     TweetApiUtilsData,
     TwitterApiUtilsRaw,
     TwitterApiUtilsResponse,
@@ -198,17 +201,45 @@ def tweet_results_converter(tweetResults: models.ItemResult) -> Optional[models.
     raise Exception()
 
 
+def item_contents(item: List[models.TimelineAddEntry]) -> List[Any]:
+    """Every item of the entries, module items included (TimelineTweet, TimelineUser, TimelineTrend, ...)."""
+
+    def map_fn(x: models.TimelineAddEntry) -> List[Any]:
+        one_of = x.content.actual_instance
+        if isinstance(one_of, models.TimelineTimelineItem):
+            return [one_of.item_content.actual_instance]
+        elif isinstance(one_of, models.TimelineTimelineModule):
+            return [y.item.item_content.actual_instance for y in one_of.items or []]
+        return []
+
+    return flat(list(map(map_fn, item)))
+
+
 def user_entries_converter(
     item: list[models.TimelineAddEntry],
 ) -> list[models.UserResults]:
-    def map_fn(x: models.TimelineAddEntry) -> Optional[models.UserResults]:
-        one_of = x.content.actual_instance
-        if isinstance(one_of, models.TimelineTimelineItem):
-            item = one_of.item_content.actual_instance
-            if isinstance(item, models.TimelineUser):
-                return item.user_results
+    return [x.user_results for x in item_contents(item) if isinstance(x, models.TimelineUser)]
 
-    return non_nullable_list(list(map(map_fn, item)))
+
+def trend_entries_converter(item: List[models.TimelineAddEntry]) -> List[models.TimelineTrend]:
+    return [x for x in item_contents(item) if isinstance(x, models.TimelineTrend)]
+
+
+def notification_entries_converter(item: List[models.TimelineAddEntry]) -> List[models.TimelineNotification]:
+    return [x for x in item_contents(item) if isinstance(x, models.TimelineNotification)]
+
+
+def list_entries_converter(item: List[models.TimelineAddEntry]) -> List[models.TwitterList]:
+    return [x.list for x in item_contents(item) if isinstance(x, models.TimelineTwitterList)]
+
+
+def community_entries_converter(item: List[models.TimelineAddEntry]) -> List[CommunityApiUtilsData]:
+    def map_fn(x: models.TimelineCommunity) -> Optional[CommunityApiUtilsData]:
+        community = x.community_results.result.actual_instance
+        if isinstance(community, models.Community):
+            return CommunityApiUtilsData(raw=x, community=community)
+
+    return non_nullable_list([map_fn(x) for x in item_contents(item) if isinstance(x, models.TimelineCommunity)])
 
 
 def user_result_converter(item: list[models.UserResults]) -> List[UserApiUtilsData]:
@@ -270,6 +301,36 @@ def build_header(headers: Dict[str, str]) -> ApiUtilsHeader:
     )
 
 
+def timeline_request(
+    api_fn: Callable[..., twitter.ApiResponse[T1]],
+    flag: ParamType,
+    ct: ClientTransaction,
+    convert_fn: Callable[[T1], List[models.InstructionUnion]],
+    param: ParamType,
+    items_fn: Callable[[List[models.TimelineAddEntry]], List[T2]],
+) -> TwitterApiUtilsResponse[TimelineApiUtilsResponse[T2]]:
+    res = api_fn(**get_kwargs(flag=flag, additional=param, ct=ct))
+    instruction = convert_fn(res.data)
+    entry = instruction_to_entry(instruction)
+    data = TimelineApiUtilsResponse[T2](
+        raw=ApiUtilsRaw(instruction=instruction, entry=entry),
+        cursor=entries_cursor(entry),
+        data=items_fn(entry),
+    )
+    return build_response(res, data)
+
+
+def data_request(
+    api_fn: Callable[..., twitter.ApiResponse[T1]],
+    flag: ParamType,
+    ct: ClientTransaction,
+    convert_fn: Callable[[T1], T2],
+    param: ParamType,
+) -> TwitterApiUtilsResponse[T2]:
+    res = api_fn(**get_kwargs(flag=flag, additional=param, ct=ct))
+    return build_response(res, convert_fn(res.data))
+
+
 def build_response(response: twitter.ApiResponse, data: T1) -> TwitterApiUtilsResponse[T1]:
     if response.headers is None:
         raise Exception("headers is None")

{twitter_openapi_python-0.1.0.dist-info → twitter_openapi_python-0.1.2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: twitter_openapi_python
-Version: 0.1.0
+Version: 0.1.2
 Summary: Twitter OpenAPI
 Keywords: twitter,api,python,scraper
 Author: fa0311
@@ -8,7 +8,7 @@ Author-email: fa0311 <yuki@yuki0311.com>
 License-Expression: LicenseRef-Custom OR AGPL-3.0-or-later
 License-File: LICENSE
 License-File: LICENSE.AGPL
-Requires-Dist: twitter-openapi-python-generated==0.1.0
+Requires-Dist: twitter-openapi-python-generated==0.1.2
 Requires-Dist: pydantic>=2.6
 Requires-Dist: requests>=2.31.0,<3.0.0
 Requires-Dist: urllib3>=2.1.0,<3.0.0

twitter_openapi_python-0.1.2.dist-info/RECORD

@@ -0,0 +1,29 @@
+twitter_openapi_python/__init__.py,sha256=IyCanHNVJtKPGaYEMBqF37VXfMtZNUJlPhSOZMvO5jg,324
+twitter_openapi_python/api/__init__.py,sha256=1YPsr8wnqlrBFAViXCwYwDdk2kNwA6PMC8DAnsWC62U,772
+twitter_openapi_python/api/birdwatch_api.py,sha256=_SpT0-RU3GhEvYa9Sqf7JpC62kxnE-u0CbUnCHNTrBM,4121
+twitter_openapi_python/api/community_api.py,sha256=hht31A83v3BfqcYa1-H9LyNIKd7UJMUWM9kzMUEJCus,5379
+twitter_openapi_python/api/default_api.py,sha256=iuzWVgQsjZtsa5E6fVXESOJzXVx0u7iVnfGPwjo96hs,5334
+twitter_openapi_python/api/initial_state_api.py,sha256=nAkb25-btWdMoSyyncxS_VrBQ9uKDgzmG7jBubfETYo,2269
+twitter_openapi_python/api/post_api.py,sha256=YSiGjV95AxxxSukZZESVRJ34D8hde6YRjd0Q6ElQ8fE,13166
+twitter_openapi_python/api/tweet_api.py,sha256=gBa0-7Pwvfau56SpTuY30t7-7wZ-2txRefW8vTnLZoE,23476
+twitter_openapi_python/api/user_api.py,sha256=CF9ST6jNI54H_ShBZLT-O1uu1h-xkaKKJmcQ0Au0H7g,4477
+twitter_openapi_python/api/user_list_api.py,sha256=VNMbvGxwV5t-77-H5x6vs55bcnbnVW5rRk9AjwKk2mw,13061
+twitter_openapi_python/api/users_api.py,sha256=u7jauEpXJ-beXcOl054Vpz8WZOIh2ubma0bPnU5JECY,2440
+twitter_openapi_python/api/v11_get_api.py,sha256=UXe34f6IBYExqWCJ8HCld_8d_ChQb92je0G5VtLxmyM,1978
+twitter_openapi_python/api/v11_post_api.py,sha256=eErGBOo-y4E1AAMIHgeWnc0rAFmc5KgIoipJI-8V0Y8,1781
+twitter_openapi_python/client.py,sha256=jeh0TGhNcBjyghnwaSV9Uz6YrmKf_3S1VFAbcgwMv8c,7126
+twitter_openapi_python/models/__init__.py,sha256=pHISZJrEPBlXS25kMydl1SxXuCct-CUpnPDfL7kEEBo,588
+twitter_openapi_python/models/base.py,sha256=3sw6wdQn9i8FoujFxhEFVWIB26-qjI6JTDuXKuebM0Y,189
+twitter_openapi_python/models/header.py,sha256=EKujtBRZOJmeh2SD1QOCsLWaE9gdGY4wsNUgwCnbTCU,644
+twitter_openapi_python/models/initial_state.py,sha256=XULKiYznCIG5TsLfV5RGPD_xOiE2bmKt1C8EtL-tQKM,513
+twitter_openapi_python/models/response.py,sha256=ziBYbwdGSeCN3zfu5mFTTd8613zaZetzkZf8y_roTaI,461
+twitter_openapi_python/models/timeline.py,sha256=dRMoc7zqyW_E2iehs4F6HfX8Iy_1b-e3Uo_c2b6Apbg,1484
+twitter_openapi_python/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+twitter_openapi_python/tid.py,sha256=xjqJMyPOp62nw2MQjMGHaB4L6G6OZHuWkMR-WKJo7aU,1120
+twitter_openapi_python/utils/__init__.py,sha256=lIEPoDqtgCvUk0A8cWqdTlTWMhkEp_NbVxL7sJ0uiu8,612
+twitter_openapi_python/utils/api.py,sha256=ytdYSv08LYGCe8gof4DptzhjCkgIBV1uJmJXC9htQnU,12623
+twitter_openapi_python-0.1.2.dist-info/licenses/LICENSE,sha256=sLv8EMhrPCMG_LeweYvYKS_B-cDMBwBSKZel7LSMGAs,1493
+twitter_openapi_python-0.1.2.dist-info/licenses/LICENSE.AGPL,sha256=TfPDBt3ar0uv_f9cqCDMZ5rIzW3CY8anRRd4PkL6ejs,34522
+twitter_openapi_python-0.1.2.dist-info/WHEEL,sha256=9IUYslYuG_asT4WlWvfk_K76nveuLvSTKDoLeL0cV-Q,80
+twitter_openapi_python-0.1.2.dist-info/METADATA,sha256=Cm2f6SkQGROikAKlvltINUo-9xUaMtW4i50SOyt5kYY,3232
+twitter_openapi_python-0.1.2.dist-info/RECORD,,

twitter_openapi_python-0.1.0.dist-info/RECORD

@@ -1,27 +0,0 @@
-twitter_openapi_python/__init__.py,sha256=IyCanHNVJtKPGaYEMBqF37VXfMtZNUJlPhSOZMvO5jg,324
-twitter_openapi_python/api/__init__.py,sha256=m9S_EoojMhead7EToafmdHKUxpyYHm9-qaKN_auWhSM,630
-twitter_openapi_python/api/default_api.py,sha256=34l_jG5Mq1u0StPRX-QfGYHoGVYP8EEY_-5vFG_Xz7o,2586
-twitter_openapi_python/api/initial_state_api.py,sha256=nAkb25-btWdMoSyyncxS_VrBQ9uKDgzmG7jBubfETYo,2269
-twitter_openapi_python/api/post_api.py,sha256=uM-TzRKJQo5mFLXk8h8eu0zfYRXAvIZ0uRWA1eCnyuU,6526
-twitter_openapi_python/api/tweet_api.py,sha256=F-oa2FJk4ySkUPkALp3cRindjsisbkCdyZh9XTLrRnQ,14178
-twitter_openapi_python/api/user_api.py,sha256=AmGhdLrIidDwNn9eOmA3O0kYKbyustv3ZlrZdxTcvwc,2457
-twitter_openapi_python/api/user_list_api.py,sha256=KYNYZfBFuvvZQERJcVjj5ZYc93tuCLNNOMv7r3dknOo,5502
-twitter_openapi_python/api/users_api.py,sha256=8bcRi-kYZ9MtsgTxYDU1SnVqKtcyQ1b7QqWEVXVafqk,1750
-twitter_openapi_python/api/v11_get_api.py,sha256=UXe34f6IBYExqWCJ8HCld_8d_ChQb92je0G5VtLxmyM,1978
-twitter_openapi_python/api/v11_post_api.py,sha256=eErGBOo-y4E1AAMIHgeWnc0rAFmc5KgIoipJI-8V0Y8,1781
-twitter_openapi_python/client.py,sha256=LUGEgRmCgnqNJJwQu1WO3ssJfQjVUzhvnf7vchF1UuM,6786
-twitter_openapi_python/models/__init__.py,sha256=Mt28XGFXzAauvwrjFhKyKpo2ZoN7uP_TMq-d9JuM9qk,561
-twitter_openapi_python/models/base.py,sha256=3sw6wdQn9i8FoujFxhEFVWIB26-qjI6JTDuXKuebM0Y,189
-twitter_openapi_python/models/header.py,sha256=EKujtBRZOJmeh2SD1QOCsLWaE9gdGY4wsNUgwCnbTCU,644
-twitter_openapi_python/models/initial_state.py,sha256=XULKiYznCIG5TsLfV5RGPD_xOiE2bmKt1C8EtL-tQKM,513
-twitter_openapi_python/models/response.py,sha256=ziBYbwdGSeCN3zfu5mFTTd8613zaZetzkZf8y_roTaI,461
-twitter_openapi_python/models/timeline.py,sha256=5oyOUgCtrfuY8hDPVgAL2-s7Ma4jOdzWtV8kiCR1V98,1356
-twitter_openapi_python/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-twitter_openapi_python/tid.py,sha256=xjqJMyPOp62nw2MQjMGHaB4L6G6OZHuWkMR-WKJo7aU,1120
-twitter_openapi_python/utils/__init__.py,sha256=dCcm68kn5uv5rCRMLRd0rpeN6hAKulIz9khp0HLgx1c,427
-twitter_openapi_python/utils/api.py,sha256=k51VenadKXzLeoA_fS9YyAb_Ufx6Hz7p_l3WnITdUBs,10131
-twitter_openapi_python-0.1.0.dist-info/licenses/LICENSE,sha256=sLv8EMhrPCMG_LeweYvYKS_B-cDMBwBSKZel7LSMGAs,1493
-twitter_openapi_python-0.1.0.dist-info/licenses/LICENSE.AGPL,sha256=TfPDBt3ar0uv_f9cqCDMZ5rIzW3CY8anRRd4PkL6ejs,34522
-twitter_openapi_python-0.1.0.dist-info/WHEEL,sha256=9IUYslYuG_asT4WlWvfk_K76nveuLvSTKDoLeL0cV-Q,80
-twitter_openapi_python-0.1.0.dist-info/METADATA,sha256=c1EtDT83hxNtKvGdwrrHX77NyF-k1LEtR69Kohl-hkw,3232
-twitter_openapi_python-0.1.0.dist-info/RECORD,,