twitter-openapi-python 0.0.24__tar.gz → 0.0.27__tar.gz

twitter_openapi_python-0.0.27/PKG-INFO

@@ -0,0 +1,102 @@
+Metadata-Version: 2.1
+Name: twitter_openapi_python
+Version: 0.0.27
+Summary: Twitter OpenAPI
+Home-page: https://github.com/fa0311/twitter_openapi_python
+Author: fa0311
+Author-email: yuki@yuki0311.com
+License: proprietary or AGPL-3.0-or-later
+Keywords: OpenAPI,OpenAPI-Generator,Twitter OpenAPI
+Description-Content-Type: text/markdown
+License-File: LICENSE
+License-File: LICENSE.AGPL
+
+# twitter_openapi_python
+
+Twitter scraping with data validation by pydantic.
+
+![1691572735537](https://raw.githubusercontent.com/fa0311/twitter_openapi_python/refs/heads/master/twitter_openapi_python/docs/image/README/1691572735537.png)
+
+## Setup
+
+```shell
+pip install twitter-openapi-python
+```
+
+## Usage
+
+```python
+import json
+import datetime
+
+from pathlib import Path
+from tweepy_authlib import CookieSessionUserHandler
+from twitter_openapi_python import TwitterOpenapiPython
+
+# login by tweepy_authlib
+if Path("cookie.json").exists():
+    with open("cookie.json", "r") as f:
+        cookies_dict = json.load(f)
+        if isinstance(cookies_dict, list):
+            cookies_dict = {k["name"]: k["value"] for k in cookies_dict}
+else:
+    auth_handler = CookieSessionUserHandler(
+        screen_name=input("screen_name: "),
+        password=input("password: "),
+    )
+    cookies_dict = auth_handler.get_cookies().get_dict()
+
+# To extract cookies from Windows (Linux by default)
+# If you use tweepy_authlib, you must be on Windows
+client = TwitterOpenapiPython()
+client.additional_api_headers = {
+    "sec-ch-ua-platform": '"Windows"',
+}
+client.additional_browser_headers = {
+    "sec-ch-ua-platform": '"Windows"',
+}
+
+# get client from cookies
+撫 = client.get_client_from_cookies(cookies=cookies_dict)
+
+# tweet "Hello World!!" with current time
+time = datetime.datetime.now().strftime("%Y-%m-%dT%H:%M:%SZ")
+撫.get_post_api().post_create_tweet(tweet_text=f"Hello World!!{time}")
+
+# get user info
+response = 撫.get_user_api().get_user_by_screen_name("elonmusk")
+```
+
+### Login
+
+```python
+from twitter_openapi_python import TwitterOpenapiPython
+
+# guest client
+撫 = TwitterOpenapiPython().get_guest_client()
+tweet = 撫.get_default_api().get_tweet_result_by_rest_id("1349129669258448897")
+assert tweet.data is not None
+assert tweet.data.tweet.legacy is not None
+print(tweet.data.tweet.legacy.full_text)
+```
+
+### Multiple OS
+
+The Token can only be used on the same OS that issued the Token
+In other words, if the sec-ch-ua-platform does not match, the Token cannot be used.
+This library uses the Linux Chrome header by default.
+To use Token issued by Windows, do the following.
+
+```python
+client = TwitterOpenapiPython()
+client.additional_api_headers = {
+  "sec-ch-ua-platform": '"Windows"',
+};
+```
+
+## License
+
+This project is dual licensed. You can choose one of the following licenses:
+
+- [Custom License](./LICENSE)
+- [GNU Affero General Public License v3.0](./LICENSE.AGPL)

{twitter_openapi_python-0.0.24 → twitter_openapi_python-0.0.27}/README.md

@@ -33,8 +33,18 @@ else:
     )
     cookies_dict = auth_handler.get_cookies().get_dict()
 
+# To extract cookies from Windows (Linux by default)
+# If you use tweepy_authlib, you must be on Windows
+client = TwitterOpenapiPython()
+client.additional_api_headers = {
+    "sec-ch-ua-platform": '"Windows"',
+}
+client.additional_browser_headers = {
+    "sec-ch-ua-platform": '"Windows"',
+}
+
 # get client from cookies
-𝕏 = TwitterOpenapiPython().get_client_from_cookies(cookies=cookies_dict)
+𝕏 = client.get_client_from_cookies(cookies=cookies_dict)
 
 # tweet "Hello World!!" with current time
 time = datetime.datetime.now().strftime("%Y-%m-%dT%H:%M:%SZ")
@@ -64,8 +74,9 @@ In other words, if the sec-ch-ua-platform does not match, the Token cannot be us
 This library uses the Linux Chrome header by default.
 To use Token issued by Windows, do the following.
 
-```typescript
-TwitterOpenapiPython.additional_api_headers = {
+```python
+client = TwitterOpenapiPython()
+client.additional_api_headers = {
   "sec-ch-ua-platform": '"Windows"',
 };
 ```

{twitter_openapi_python-0.0.24 → twitter_openapi_python-0.0.27}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "twitter_openapi_python"
-version = "0.0.24"
+version = "0.0.27"
 description = "Twitter OpenAPI"
 authors = ["fa0311 <yuki@yuki0311.com>"]
 license = "proprietary" # or "AGPL-3.0-only"
@@ -14,7 +14,7 @@ include = ["twitter_openapi_python/py.typed"]
 python = "^3.7"
 pydantic = ">=2.6"
 
-twitter-openapi-python-generated = "0.0.21"
+twitter-openapi-python-generated = "0.0.25"
 
 [tool.poetry.dev-dependencies]
 
@@ -27,4 +27,7 @@ extension-pkg-whitelist = "pydantic"
 
 [tool.pyright]
 reportPrivateImportUsage = false
-typeCheckingMode = "standard"
+typeCheckingMode = "standard"
+
+[tool.ruff]
+line-length = 120

{twitter_openapi_python-0.0.24 → twitter_openapi_python-0.0.27}/setup.py

@@ -1,14 +1,28 @@
 # coding: utf-8
 
+import re
+
 from setuptools import find_packages, setup
 
 NAME = "twitter_openapi_python"
-VERSION = "0.0.24"
+VERSION = "0.0.27"
 PYTHON_REQUIRES = ">=3.7"
 REQUIRES = [
-    "twitter_openapi_python_generated == 0.0.21",
+    "twitter_openapi_python_generated == 0.0.25",
     "pydantic >= 2.6",
 ]
+GITHUB_RAW_URL = (
+    "https://raw.githubusercontent.com/fa0311/twitter_openapi_python/refs/heads/master/twitter_openapi_python/"
+)
+
+
+def image_replace(text: str, url: str):
+    return re.sub(
+        r"!\[(.*?)\]\((.*?)\)",
+        r"![\1](" + url + r"\2)",
+        text,
+    )
+
 
 setup(
     name=NAME,
@@ -23,8 +37,6 @@ setup(
     include_package_data=True,
     license="proprietary or AGPL-3.0-or-later",
     long_description_content_type="text/markdown",
-    long_description="""\
-        Twitter scraping with data validation by pydantic.
-    """,  # noqa: E501
+    long_description=image_replace(open("README.md").read(), GITHUB_RAW_URL),
     package_data={"twitter_openapi_python": ["py.typed"]},
 )

{twitter_openapi_python-0.0.24 → twitter_openapi_python-0.0.27}/twitter_openapi_python/api/default_api.py

@@ -1,4 +1,4 @@
-from typing import Any, Callable, Optional, Type, TypeVar
+from typing import Any, Callable, Optional, TypeVar
 
 import twitter_openapi_python_generated as twitter
 import twitter_openapi_python_generated.models as models
@@ -7,13 +7,13 @@ from twitter_openapi_python.models import TweetApiUtilsData, TwitterApiUtilsResp
 from twitter_openapi_python.utils import (
     build_response,
     build_tweet_api_utils,
-    check_error,
     get_kwargs,
 )
+from twitter_openapi_python.utils.api import error_check
 
 T1 = TypeVar("T1")
 T2 = TypeVar("T2")
-ApiFnType = Callable[..., twitter.ApiResponse]
+ApiFnType = Callable[..., twitter.ApiResponse[T1]]
 ParamType = dict[str, Any]
 
 
@@ -27,20 +27,15 @@ class DefaultApiUtils:
 
     def request(
         self,
-        apiFn: ApiFnType,
+        apiFn: "ApiFnType[T1]",
         convertFn: Callable[[T1], T2],
-        type1: Type[T1],
-        type2: Type[T2],
         key: str,
         param: ParamType,
-    ) -> TwitterApiUtilsResponse[T2]:
+    ):
         args = get_kwargs(flag=self.flag[key], additional=param)
         res = apiFn(**args)
-        checked = check_error(data=res, type=type1)
-
-        data = convertFn(checked)
-
-        return build_response(response=res, data=data)
+        data = convertFn(res.data)
+        return build_response(res, data)
 
     def get_profile_spotlights_query(
         self,
@@ -55,9 +50,7 @@ class DefaultApiUtils:
 
         response = self.request(
             apiFn=self.api.get_profile_spotlights_query_with_http_info,
-            convertFn=lambda x: x.data.user_result_by_screen_name,
-            type1=models.ProfileResponse,
-            type2=models.UserResultByScreenName,
+            convertFn=lambda x: error_check(x.data.user_result_by_screen_name, x.errors),
             key="ProfileSpotlightsQuery",
             param=param,
         )
@@ -74,9 +67,9 @@ class DefaultApiUtils:
 
         response = self.request(
             apiFn=self.api.get_tweet_result_by_rest_id_with_http_info,
-            convertFn=lambda x: build_tweet_api_utils(x.data.tweet_result),
-            type1=models.TweetResultByRestIdResponse,
-            type2=TweetApiUtilsData,
+            convertFn=lambda x: error_check(
+                build_tweet_api_utils(error_check(x.data.tweet_result, x.errors)), x.errors
+            ),
             key="TweetResultByRestId",
             param=param,
         )

{twitter_openapi_python-0.0.24 → twitter_openapi_python-0.0.27}/twitter_openapi_python/api/initial_state_api.py

@@ -33,9 +33,7 @@ class InitialStateApiUtils:
     def get_initial_state(self, url: str) -> InitialStateApiUtilsResponse:
         response = self.request(url=url).data.decode("utf-8")
         reg = '<script type="text/javascript" charset="utf-8" nonce="{nonce}">{any}</script>'
-        js = re.search(
-            reg.format(nonce=r"([a-zA-Z0-9]{48})", any=r"([\s\S]*?)"), response
-        )
+        js = re.search(reg.format(nonce=r"([a-zA-Z0-9]{48})", any=r"([\s\S]*?)"), response)
 
         if js is None:
             raise Exception("js is None")
@@ -56,14 +54,14 @@ class InitialStateApiUtils:
         def get_user(e: dict[str, Any]) -> Optional[models.UserLegacy]:
             try:
                 entities = e["entities"]["users"]["entities"]
-                return models.UserLegacy.parse_obj(list(entities.values())[0])
+                return models.UserLegacy.model_validate(list(entities.values())[0])
             except Exception:
                 # todo: fix
                 return None
 
         def get_session(e: dict[str, Any]) -> Optional[models.Session]:
             try:
-                return models.Session.parse_obj(e["session"])
+                return models.Session.model_validate(e["session"])
             except Exception:
                 return None
 

{twitter_openapi_python-0.0.24 → twitter_openapi_python-0.0.27}/twitter_openapi_python/api/post_api.py

@@ -4,7 +4,7 @@ import twitter_openapi_python_generated as twitter
 import twitter_openapi_python_generated.models as models
 
 from twitter_openapi_python.models import TwitterApiUtilsResponse
-from twitter_openapi_python.utils import build_response, check_error, non_nullable
+from twitter_openapi_python.utils import build_response, non_nullable
 
 T = TypeVar("T")
 ResponseType = TwitterApiUtilsResponse[T]
@@ -19,14 +19,6 @@ class PostApiUtils:
         self.api = api
         self.flag = flag
 
-    def builder(
-        self,
-        res: twitter.ApiResponse,
-        type: type[T],
-    ) -> ResponseType[T]:
-        checked = check_error(data=res, type=type)
-        return build_response(response=res, data=checked)
-
     def post_create_tweet(
         self,
         tweet_text: str,
@@ -37,15 +29,9 @@ class PostApiUtils:
         conversation_control: Optional[str] = None,
     ) -> ResponseType[models.CreateTweetResponse]:
         variables = non_nullable(
-            twitter.PostCreateTweetRequestVariables.from_dict(
-                self.flag["CreateTweet"]["variables"]
-            )
-        )
-        features = non_nullable(
-            twitter.PostCreateTweetRequestFeatures.from_dict(
-                self.flag["CreateTweet"]["features"]
-            )
+            twitter.PostCreateTweetRequestVariables.from_dict(self.flag["CreateTweet"]["variables"])
         )
+        features = non_nullable(twitter.PostCreateTweetRequestFeatures.from_dict(self.flag["CreateTweet"]["features"]))
         variables.tweet_text = tweet_text
         if media_ids:
             tagged_or = tagged_users or []
@@ -58,10 +44,8 @@ class PostApiUtils:
             ]
         variables.attachment_url = attachment_url
         if conversation_control:
-            variables.conversation_control = (
-                twitter.PostCreateTweetRequestVariablesConversationControl(
-                    mode=conversation_control
-                )
+            variables.conversation_control = twitter.PostCreateTweetRequestVariablesConversationControl(
+                mode=conversation_control
             )
 
         if in_reply_to_tweet_id:
@@ -78,17 +62,14 @@ class PostApiUtils:
                 features=features,
             ),
         )
-
-        return self.builder(res=res, type=models.CreateTweetResponse)
+        return build_response(res, res.data)
 
     def post_delete_tweet(
         self,
         tweet_id: str,
     ) -> ResponseType[models.DeleteTweetResponse]:
         variables = non_nullable(
-            twitter.PostCreateRetweetRequestVariables.from_dict(
-                self.flag["DeleteTweet"]["variables"]
-            )
+            twitter.PostCreateRetweetRequestVariables.from_dict(self.flag["DeleteTweet"]["variables"])
         )
         variables.tweet_id = tweet_id
 
@@ -99,17 +80,14 @@ class PostApiUtils:
                 variables=variables,
             ),
         )
-
-        return self.builder(res=res, type=models.DeleteTweetResponse)
+        return build_response(res, res.data)
 
     def post_create_retweet(
         self,
         tweet_id: str,
     ) -> ResponseType[models.CreateRetweetResponse]:
         variables = non_nullable(
-            twitter.PostCreateRetweetRequestVariables.from_dict(
-                self.flag["CreateRetweet"]["variables"]
-            )
+            twitter.PostCreateRetweetRequestVariables.from_dict(self.flag["CreateRetweet"]["variables"])
         )
         variables.tweet_id = tweet_id
 
@@ -120,17 +98,14 @@ class PostApiUtils:
                 variables=variables,
             ),
         )
-
-        return self.builder(res=res, type=models.CreateRetweetResponse)
+        return build_response(res, res.data)
 
     def post_delete_retweet(
         self,
         source_tweet_id: str,
     ) -> ResponseType[models.DeleteRetweetResponse]:
         variables = non_nullable(
-            twitter.PostDeleteRetweetRequestVariables.from_dict(
-                self.flag["DeleteRetweet"]["variables"]
-            )
+            twitter.PostDeleteRetweetRequestVariables.from_dict(self.flag["DeleteRetweet"]["variables"])
         )
         variables.source_tweet_id = source_tweet_id
 
@@ -141,18 +116,15 @@ class PostApiUtils:
                 variables=variables,
             ),
         )
-
-        return self.builder(res=res, type=models.DeleteRetweetResponse)
+        return build_response(res, res.data)
 
     # postFavoriteTweet
     def post_favorite_tweet(
         self,
         tweet_id: str,
-    ) -> ResponseType[models.FavoriteTweetResponseData]:
+    ) -> ResponseType[models.FavoriteTweetResponse]:
         variables = non_nullable(
-            twitter.PostCreateBookmarkRequestVariables.from_dict(
-                self.flag["FavoriteTweet"]["variables"]
-            )
+            twitter.PostCreateBookmarkRequestVariables.from_dict(self.flag["FavoriteTweet"]["variables"])
         )
         variables.tweet_id = tweet_id
 
@@ -163,17 +135,15 @@ class PostApiUtils:
                 variables=variables,
             ),
         )
-        return self.builder(res=res, type=models.FavoriteTweetResponseData)
+        return build_response(res, res.data)
 
     # postUnfavoriteTweet
     def post_unfavorite_tweet(
         self,
         tweet_id: str,
-    ) -> ResponseType[models.UnfavoriteTweetResponseData]:
+    ) -> ResponseType[models.UnfavoriteTweetResponse]:
         variables = non_nullable(
-            twitter.PostCreateRetweetRequestVariables.from_dict(
-                self.flag["UnfavoriteTweet"]["variables"]
-            )
+            twitter.PostCreateRetweetRequestVariables.from_dict(self.flag["UnfavoriteTweet"]["variables"])
         )
         variables.tweet_id = tweet_id
 
@@ -184,4 +154,4 @@ class PostApiUtils:
                 variables=variables,
             ),
         )
-        return self.builder(res=res, type=models.UnfavoriteTweetResponseData)
+        return build_response(res, res.data)

{twitter_openapi_python-0.0.24 → twitter_openapi_python-0.0.27}/twitter_openapi_python/api/tweet_api.py

@@ -1,4 +1,4 @@
-from typing import Any, Callable, List, Optional, Type, TypeVar
+from typing import Any, Callable, List, Optional, TypeVar
 
 import twitter_openapi_python_generated as twitter
 import twitter_openapi_python_generated.models as models
@@ -11,17 +11,16 @@ from twitter_openapi_python.models import (
 )
 from twitter_openapi_python.utils import (
     build_response,
-    check_error,
     entries_cursor,
+    error_check,
     get_kwargs,
     instruction_to_entry,
     tweet_entries_converter,
 )
-from twitter_openapi_python.utils.api import non_nullable
 
 T = TypeVar("T")
 ResponseType = TwitterApiUtilsResponse[TimelineApiUtilsResponse[TweetApiUtilsData]]
-ApiFnType = Callable[..., twitter.ApiResponse]
+ApiFnType = Callable[..., twitter.ApiResponse[T]]
 ParamType = dict[str, Any]
 
 
@@ -35,17 +34,14 @@ class TweetApiUtils:
 
     def request(
         self,
-        apiFn: ApiFnType,
+        apiFn: "ApiFnType[T]",
         convertFn: Callable[[T], List[models.InstructionUnion]],
-        type: Type[T],
         key: str,
         param: ParamType,
     ) -> ResponseType:
         args = get_kwargs(flag=self.flag[key], additional=param)
         res = apiFn(**args)
-        checked = check_error(data=res, type=type)
-
-        instruction = convertFn(checked)
+        instruction = convertFn(res.data)
         entry = instruction_to_entry(instruction)
         tweet_list = tweet_entries_converter(entry)
         raw = ApiUtilsRaw(
@@ -57,8 +53,7 @@ class TweetApiUtils:
             cursor=entries_cursor(entry),
             data=tweet_list,
         )
-
-        return build_response(response=res, data=data)
+        return build_response(res, data)
 
     def get_tweet_detail(
         self,
@@ -77,8 +72,7 @@ class TweetApiUtils:
 
         response = self.request(
             apiFn=self.api.get_tweet_detail_with_http_info,
-            convertFn=lambda e: e.data.threaded_conversation_with_injections_v2.instructions,
-            type=models.TweetDetailResponse,
+            convertFn=lambda e: error_check(e.data.threaded_conversation_with_injections_v2, e.errors).instructions,
             key="TweetDetail",
             param=param,
         )
@@ -104,8 +98,7 @@ class TweetApiUtils:
 
         response = self.request(
             apiFn=self.api.get_search_timeline_with_http_info,
-            convertFn=lambda e: e.data.search_by_raw_query.search_timeline.timeline.instructions,
-            type=models.SearchTimelineResponse,
+            convertFn=lambda e: error_check(e.data.search_by_raw_query, e.errors).search_timeline.timeline.instructions,
             key="SearchTimeline",
             param=param,
         )
@@ -127,8 +120,7 @@ class TweetApiUtils:
 
         response = self.request(
             apiFn=self.api.get_home_timeline_with_http_info,
-            convertFn=lambda e: e.data.home.home_timeline_urt.instructions,
-            type=models.TimelineResponse,
+            convertFn=lambda e: error_check(e.data.home, e.errors).home_timeline_urt.instructions,
             key="HomeTimeline",
             param=param,
         )
@@ -150,8 +142,7 @@ class TweetApiUtils:
 
         response = self.request(
             apiFn=self.api.get_home_latest_timeline_with_http_info,
-            convertFn=lambda e: e.data.home.home_timeline_urt.instructions,
-            type=models.TimelineResponse,
+            convertFn=lambda e: error_check(e.data.home, e.errors).home_timeline_urt.instructions,
             key="HomeLatestTimeline",
             param=param,
         )
@@ -174,10 +165,9 @@ class TweetApiUtils:
 
         response = self.request(
             apiFn=self.api.get_list_latest_tweets_timeline_with_http_info,
-            convertFn=lambda e: []
-            if (x := e.data.list.tweets_timeline.timeline) is None
-            else x.instructions,
-            type=models.ListLatestTweetsTimelineResponse,
+            convertFn=lambda e: error_check(
+                error_check(e.data.list, e.errors).tweets_timeline.timeline, e.errors
+            ).instructions,
             key="ListLatestTweetsTimeline",
             param=param,
         )
@@ -200,10 +190,9 @@ class TweetApiUtils:
 
         response = self.request(
             apiFn=self.api.get_user_tweets_with_http_info,
-            convertFn=lambda e: non_nullable(
-                e.data.user.result.timeline_v2.timeline
+            convertFn=lambda e: error_check(
+                error_check(e.data.user, e.errors).result.timeline_v2.timeline, e.errors
             ).instructions,
-            type=models.UserTweetsResponse,
             key="UserTweets",
             param=param,
         )
@@ -226,10 +215,9 @@ class TweetApiUtils:
 
         response = self.request(
             apiFn=self.api.get_user_tweets_and_replies_with_http_info,
-            convertFn=lambda e: non_nullable(
-                e.data.user.result.timeline_v2.timeline
+            convertFn=lambda e: error_check(
+                error_check(e.data.user, e.errors).result.timeline_v2.timeline, e.errors
             ).instructions,
-            type=models.UserTweetsResponse,
             key="UserTweetsAndReplies",
             param=param,
         )
@@ -252,10 +240,9 @@ class TweetApiUtils:
 
         response = self.request(
             apiFn=self.api.get_user_media_with_http_info,
-            convertFn=lambda e: non_nullable(
-                e.data.user.result.timeline_v2.timeline
+            convertFn=lambda e: error_check(
+                error_check(e.data.user, e.errors).result.timeline_v2.timeline, e.errors
             ).instructions,
-            type=models.UserTweetsResponse,
             key="UserMedia",
             param=param,
         )
@@ -278,10 +265,9 @@ class TweetApiUtils:
 
         response = self.request(
             apiFn=self.api.get_likes_with_http_info,
-            convertFn=lambda e: non_nullable(
-                e.data.user.result.timeline_v2.timeline
+            convertFn=lambda e: error_check(
+                error_check(e.data.user, e.errors).result.timeline_v2.timeline, e.errors
             ).instructions,
-            type=models.UserTweetsResponse,
             key="Likes",
             param=param,
         )
@@ -303,8 +289,9 @@ class TweetApiUtils:
 
         response = self.request(
             apiFn=self.api.get_bookmarks_with_http_info,
-            convertFn=lambda e: e.data.bookmark_timeline_v2.timeline.instructions,
-            type=models.BookmarksResponse,
+            convertFn=lambda e: error_check(
+                error_check(e.data, e.errors).bookmark_timeline_v2.timeline, e.errors
+            ).instructions,
             key="Bookmarks",
             param=param,
         )

{twitter_openapi_python-0.0.24 → twitter_openapi_python-0.0.27}/twitter_openapi_python/api/user_api.py

@@ -1,4 +1,4 @@
-from typing import Any, Callable, Optional, Type, TypeVar
+from typing import Any, Callable, Optional, TypeVar
 
 import twitter_openapi_python_generated as twitter
 import twitter_openapi_python_generated.models as models
@@ -6,14 +6,14 @@ import twitter_openapi_python_generated.models as models
 from twitter_openapi_python.models import TwitterApiUtilsResponse, UserApiUtilsData
 from twitter_openapi_python.utils import (
     build_response,
-    check_error,
+    error_check,
     get_kwargs,
     user_or_null_converter,
 )
 
 T = TypeVar("T")
 ResponseType = TwitterApiUtilsResponse[UserApiUtilsData]
-ApiFnType = Callable[..., twitter.ApiResponse]
+ApiFnType = Callable[..., twitter.ApiResponse[T]]
 ParamType = dict[str, Any]
 
 
@@ -27,27 +27,19 @@ class UserApiUtils:
 
     def request(
         self,
-        apiFn: ApiFnType,
+        apiFn: "ApiFnType[T]",
         convertFn: Callable[[T], models.UserResults],
-        type: Type[T],
         key: str,
         param: ParamType,
     ) -> ResponseType:
         args = get_kwargs(flag=self.flag[key], additional=param)
         res = apiFn(**args)
-        checked = check_error(data=res, type=type)
-
-        result = convertFn(checked)
+        result = convertFn(res.data)
         if result.result is None:
-            # never reach this point.
             raise Exception("No user")
-
         user = user_or_null_converter(result.result)
-
         if user is None:
-            # never reach this point.
             raise Exception("No user")
-
         data = UserApiUtilsData(
             raw=result,
             user=user,
@@ -65,8 +57,7 @@ class UserApiUtils:
             param.update(extra_param)
         return self.request(
             apiFn=self.api.get_user_by_screen_name_with_http_info,
-            convertFn=lambda e: e.data.user,
-            type=models.UserResponse,
+            convertFn=lambda e: error_check(e.data.user, e.errors),
             key="UserByScreenName",
             param=param,
         )
@@ -81,8 +72,7 @@ class UserApiUtils:
             param.update(extra_param)
         return self.request(
             apiFn=self.api.get_user_by_rest_id_with_http_info,
-            convertFn=lambda e: e.data.user,
-            type=models.UserResponse,
+            convertFn=lambda e: error_check(e.data.user, e.errors),
             key="UserByRestId",
             param=param,
         )

{twitter_openapi_python-0.0.24 → twitter_openapi_python-0.0.27}/twitter_openapi_python/api/user_list_api.py

@@ -1,4 +1,4 @@
-from typing import Any, Callable, List, Optional, Type, TypeVar
+from typing import Any, Callable, List, Optional, TypeVar
 
 import twitter_openapi_python_generated as twitter
 import twitter_openapi_python_generated.models as models
@@ -11,18 +11,17 @@ from twitter_openapi_python.models import (
 )
 from twitter_openapi_python.utils import (
     build_response,
-    check_error,
     entries_cursor,
+    error_check,
     get_kwargs,
     instruction_to_entry,
-    non_nullable,
     user_entries_converter,
     user_result_converter,
 )
 
 T = TypeVar("T")
 ResponseType = TwitterApiUtilsResponse[TimelineApiUtilsResponse[UserApiUtilsData]]
-ApiFnType = Callable[..., twitter.ApiResponse]
+ApiFnType = Callable[..., twitter.ApiResponse[T]]
 ParamType = dict[str, Any]
 
 
@@ -36,17 +35,14 @@ class UserListApiUtils:
 
     def request(
         self,
-        apiFn: ApiFnType,
+        apiFn: "ApiFnType[T]",
         convertFn: Callable[[T], List[models.InstructionUnion]],
-        type: Type[T],
         key: str,
         param: ParamType,
     ) -> ResponseType:
         args = get_kwargs(flag=self.flag[key], additional=param)
         res = apiFn(**args)
-        checked = check_error(data=res, type=type)
-
-        instruction = convertFn(checked)
+        instruction = convertFn(res.data)
         entry = instruction_to_entry(instruction)
         user_list = user_entries_converter(entry)
         user = user_result_converter(user_list)
@@ -79,8 +75,7 @@ class UserListApiUtils:
             param.update(extra_param)
         return self.request(
             apiFn=self.api.get_followers_with_http_info,
-            convertFn=lambda e: e.data.user.result.timeline.timeline.instructions,
-            type=models.FollowResponse,
+            convertFn=lambda e: error_check(e.data.user, e.errors).result.timeline.timeline.instructions,
             key="Followers",
             param=param,
         )
@@ -101,8 +96,7 @@ class UserListApiUtils:
             param.update(extra_param)
         return self.request(
             apiFn=self.api.get_following_with_http_info,
-            convertFn=lambda e: e.data.user.result.timeline.timeline.instructions,
-            type=models.FollowResponse,
+            convertFn=lambda e: error_check(e.data.user, e.errors).result.timeline.timeline.instructions,
             key="Following",
             param=param,
         )
@@ -123,8 +117,7 @@ class UserListApiUtils:
             param.update(extra_param)
         return self.request(
             apiFn=self.api.get_followers_you_know_with_http_info,
-            convertFn=lambda e: e.data.user.result.timeline.timeline.instructions,
-            type=models.FollowResponse,
+            convertFn=lambda e: error_check(e.data.user, e.errors).result.timeline.timeline.instructions,
             key="FollowersYouKnow",
             param=param,
         )
@@ -145,10 +138,9 @@ class UserListApiUtils:
             param.update(extra_param)
         return self.request(
             apiFn=self.api.get_favoriters_with_http_info,
-            convertFn=lambda e: non_nullable(
-                e.data.favoriters_timeline.timeline
+            convertFn=lambda e: error_check(
+                error_check(e.data.favoriters_timeline, e.errors).timeline, e.errors
             ).instructions,
-            type=models.TweetFavoritersResponse,
             key="Favoriters",
             param=param,
         )
@@ -169,10 +161,9 @@ class UserListApiUtils:
             param.update(extra_param)
         return self.request(
             apiFn=self.api.get_retweeters_with_http_info,
-            convertFn=lambda e: non_nullable(
-                e.data.retweeters_timeline.timeline
+            convertFn=lambda e: error_check(
+                error_check(e.data.retweeters_timeline, e.errors).timeline, e.errors
             ).instructions,
-            type=models.TweetRetweetersResponse,
             key="Retweeters",
             param=param,
         )

{twitter_openapi_python-0.0.24 → twitter_openapi_python-0.0.27}/twitter_openapi_python/api/users_api.py

@@ -1,4 +1,4 @@
-from typing import Any, Callable, Optional, Type, TypeVar
+from typing import Any, Callable, Optional, TypeVar
 
 import twitter_openapi_python_generated as twitter
 import twitter_openapi_python_generated.models as models
@@ -6,14 +6,14 @@ import twitter_openapi_python_generated.models as models
 from twitter_openapi_python.models import TwitterApiUtilsResponse, UserApiUtilsData
 from twitter_openapi_python.utils import (
     build_response,
-    check_error,
+    error_check,
     get_kwargs,
     user_result_converter,
 )
 
 T = TypeVar("T")
 ResponseType = TwitterApiUtilsResponse[list[UserApiUtilsData]]
-ApiFnType = Callable[..., twitter.ApiResponse]
+ApiFnType = Callable[..., twitter.ApiResponse[T]]
 ParamType = dict[str, Any]
 
 
@@ -27,17 +27,14 @@ class UsersApiUtils:
 
     def request(
         self,
-        apiFn: ApiFnType,
+        apiFn: "ApiFnType[T]",
         convertFn: Callable[[T], list[models.UserResults]],
-        type: Type[T],
         key: str,
         param: ParamType,
     ) -> ResponseType:
         args = get_kwargs(flag=self.flag[key], additional=param)
         res = apiFn(**args)
-        checked = check_error(data=res, type=type)
-
-        user_result = convertFn(checked)
+        user_result = convertFn(res.data)
         user = user_result_converter(user_result)
         return build_response(response=res, data=user)
 
@@ -51,8 +48,7 @@ class UsersApiUtils:
             param.update(extra_param)
         return self.request(
             apiFn=self.api.get_users_by_rest_ids_with_http_info,
-            convertFn=lambda e: e.data.users,
-            type=models.UsersResponse,
+            convertFn=lambda e: error_check(e.data.users, e.errors),
             key="UsersByRestIds",
             param=param,
         )

{twitter_openapi_python-0.0.24 → twitter_openapi_python-0.0.27}/twitter_openapi_python/api/v11_get_api.py

@@ -1,5 +1,4 @@
-from types import NoneType
-from typing import Any, Callable, Optional, Type, TypeVar
+from typing import Any, Callable, Optional, TypeVar
 
 import twitter_openapi_python_generated as twitter
 
@@ -7,7 +6,7 @@ from twitter_openapi_python.models import TwitterApiUtilsResponse
 from twitter_openapi_python.utils import build_response, get_legacy_kwargs
 
 T = TypeVar("T")
-ApiFnType = Callable[..., twitter.ApiResponse]
+ApiFnType = Callable[..., twitter.ApiResponse[T]]
 ParamType = dict[str, Any]
 
 
@@ -21,18 +20,15 @@ class V11GetApiUtils:
 
     def request(
         self,
-        apiFn: ApiFnType,
-        type: Type[T],
+        apiFn: "ApiFnType[T]",
         key: str,
         param: ParamType,
     ) -> TwitterApiUtilsResponse[T]:
         args = get_legacy_kwargs(flag=self.flag[key], additional=param)
         res = apiFn(**args)
         data = res.data
-
         if not isinstance(data, type):
             raise Exception("Error")
-
         return build_response(response=res, data=data)
 
     def get_friends_following_list(
@@ -52,7 +48,6 @@ class V11GetApiUtils:
 
         response = self.request(
             apiFn=self.api.get_friends_following_list_with_http_info,
-            type=NoneType,
             param=param,
             key="friends/following/list.json",
         )
@@ -69,7 +64,6 @@ class V11GetApiUtils:
 
         response = self.request(
             apiFn=self.api.get_search_typeahead_with_http_info,
-            type=NoneType,
             param=param,
             key="search/typeahead.json",
         )

{twitter_openapi_python-0.0.24 → twitter_openapi_python-0.0.27}/twitter_openapi_python/api/v11_post_api.py

@@ -1,5 +1,4 @@
-from types import NoneType
-from typing import Any, Callable, Optional, Type, TypeVar
+from typing import Any, Callable, Optional, TypeVar
 
 import twitter_openapi_python_generated as twitter
 
@@ -7,7 +6,7 @@ from twitter_openapi_python.models import TwitterApiUtilsResponse
 from twitter_openapi_python.utils import build_response, get_legacy_kwargs
 
 T = TypeVar("T")
-ApiFnType = Callable[..., twitter.ApiResponse]
+ApiFnType = Callable[..., twitter.ApiResponse[T]]
 ParamType = dict[str, Any]
 
 
@@ -21,8 +20,7 @@ class V11PostApiUtils:
 
     def request(
         self,
-        apiFn: ApiFnType,
-        type: Type[T],
+        apiFn: "ApiFnType[T]",
         key: str,
         param: ParamType,
     ) -> TwitterApiUtilsResponse[T]:
@@ -46,7 +44,6 @@ class V11PostApiUtils:
 
         response = self.request(
             apiFn=self.api.post_create_friendships_with_http_info,
-            type=NoneType,
             param=param,
             key="friendships/create.json",
         )
@@ -63,7 +60,6 @@ class V11PostApiUtils:
 
         response = self.request(
             apiFn=self.api.post_destroy_friendships_with_http_info,
-            type=NoneType,
             param=param,
             key="friendships/destroy.json",
         )

{twitter_openapi_python-0.0.24 → twitter_openapi_python-0.0.27}/twitter_openapi_python/client.py

@@ -58,7 +58,7 @@ class TwitterOpenapiPythonClient:
 
 
 class TwitterOpenapiPython:
-    hash: str = "0c64eebbfb93b3ed69c3aba923ec8d6894a39902"
+    hash: str = "4b27150977e1bdd807de8969dc0ddd7918ac9923"
     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 = "AAAAAAAAAAAAAAAAAAAAANRILgAAAAAAnNwIzUejRCOuH5E6I8xnZz4puTs%3D1Zv7ttfk8LF81IUq16cHjhLTvJu4FA33AGWWjCpTnA"
@@ -81,7 +81,6 @@ class TwitterOpenapiPython:
             {
                 **getHader("chrome-fetch"),
                 "accept-encoding": "identity",
-                "pragma": "no-cache",
                 "referer": self.twitter_url,
                 "priority": "u=1, i",
                 "x-twitter-client-language": "en",
@@ -98,11 +97,18 @@ class TwitterOpenapiPython:
             },
         )
 
+    def remove_prefix(self, text: str) -> str:
+        if text.startswith("x-twitter-"):
+            return text[10:]
+        if text.startswith("x-"):
+            return text[2:]
+        return text
+
     def kebab_to_upper_camel(self, text: dict[str, Any]) -> dict[str, Any]:
         res = {}
         for key, value in text.items():
             new_key = "".join(
-                [x.capitalize() for x in key.replace("x-twitter-", "").split("-")]
+                [x.capitalize() for x in self.remove_prefix(key).split("-")]
             )
             res[new_key] = value
         return res

{twitter_openapi_python-0.0.24 → twitter_openapi_python-0.0.27}/twitter_openapi_python/utils/__init__.py

@@ -8,7 +8,7 @@ from twitter_openapi_python.utils.api import (
     build_header,
     build_response,
     build_tweet_api_utils,
-    check_error,
+    error_check,
     entries_cursor,
     get_kwargs,
     get_legacy_kwargs,

{twitter_openapi_python-0.0.24 → twitter_openapi_python-0.0.27}/twitter_openapi_python/utils/api.py

@@ -28,6 +28,7 @@ def non_nullable(x: Optional[T]) -> T:
         raise Exception("No data")
     return x
 
+
 def non_nullable_list(x: List[Optional[T]]) -> List[T]:
     def filter_fn(x: Optional[T]) -> TypeGuard[T]:
         return x is not None
@@ -58,15 +59,13 @@ def get_legacy_kwargs(flag: ParamType, additional: ParamType) -> ParamType:
     return res | additional
 
 
-def check_error(data: twitter.ApiResponse, type: type[T]) -> T:
-    if data.data is None:
-        raise Exception("No data")
-    oneOf = data.data.actual_instance
-    if isinstance(oneOf, models.Errors):
-        raise Exception(oneOf)
-    if isinstance(oneOf, type):
-        return oneOf
-    raise Exception("Error")
+def error_check(data: Optional[T], error: Optional[List[models.ErrorResponse]]) -> T:
+    if data is None:
+        if error is None:
+            raise Exception("No data")
+        else:
+            raise Exception(", ".join([x.message for x in error]))
+    return data
 
 
 def instruction_to_entry(
@@ -263,10 +262,7 @@ def build_header(headers: Dict[str, str]) -> ApiUtilsHeader:
     )
 
 
-def build_response(
-    response: twitter.ApiResponse,
-    data: T1,
-) -> TwitterApiUtilsResponse[T1]:
+def build_response(response: twitter.ApiResponse, data: T1) -> TwitterApiUtilsResponse[T1]:
     if response.headers is None:
         raise Exception("headers is None")
 

twitter_openapi_python-0.0.27/twitter_openapi_python.egg-info/PKG-INFO

@@ -0,0 +1,102 @@
+Metadata-Version: 2.1
+Name: twitter-openapi-python
+Version: 0.0.27
+Summary: Twitter OpenAPI
+Home-page: https://github.com/fa0311/twitter_openapi_python
+Author: fa0311
+Author-email: yuki@yuki0311.com
+License: proprietary or AGPL-3.0-or-later
+Keywords: OpenAPI,OpenAPI-Generator,Twitter OpenAPI
+Description-Content-Type: text/markdown
+License-File: LICENSE
+License-File: LICENSE.AGPL
+
+# twitter_openapi_python
+
+Twitter scraping with data validation by pydantic.
+
+![1691572735537](https://raw.githubusercontent.com/fa0311/twitter_openapi_python/refs/heads/master/twitter_openapi_python/docs/image/README/1691572735537.png)
+
+## Setup
+
+```shell
+pip install twitter-openapi-python
+```
+
+## Usage
+
+```python
+import json
+import datetime
+
+from pathlib import Path
+from tweepy_authlib import CookieSessionUserHandler
+from twitter_openapi_python import TwitterOpenapiPython
+
+# login by tweepy_authlib
+if Path("cookie.json").exists():
+    with open("cookie.json", "r") as f:
+        cookies_dict = json.load(f)
+        if isinstance(cookies_dict, list):
+            cookies_dict = {k["name"]: k["value"] for k in cookies_dict}
+else:
+    auth_handler = CookieSessionUserHandler(
+        screen_name=input("screen_name: "),
+        password=input("password: "),
+    )
+    cookies_dict = auth_handler.get_cookies().get_dict()
+
+# To extract cookies from Windows (Linux by default)
+# If you use tweepy_authlib, you must be on Windows
+client = TwitterOpenapiPython()
+client.additional_api_headers = {
+    "sec-ch-ua-platform": '"Windows"',
+}
+client.additional_browser_headers = {
+    "sec-ch-ua-platform": '"Windows"',
+}
+
+# get client from cookies
+撫 = client.get_client_from_cookies(cookies=cookies_dict)
+
+# tweet "Hello World!!" with current time
+time = datetime.datetime.now().strftime("%Y-%m-%dT%H:%M:%SZ")
+撫.get_post_api().post_create_tweet(tweet_text=f"Hello World!!{time}")
+
+# get user info
+response = 撫.get_user_api().get_user_by_screen_name("elonmusk")
+```
+
+### Login
+
+```python
+from twitter_openapi_python import TwitterOpenapiPython
+
+# guest client
+撫 = TwitterOpenapiPython().get_guest_client()
+tweet = 撫.get_default_api().get_tweet_result_by_rest_id("1349129669258448897")
+assert tweet.data is not None
+assert tweet.data.tweet.legacy is not None
+print(tweet.data.tweet.legacy.full_text)
+```
+
+### Multiple OS
+
+The Token can only be used on the same OS that issued the Token
+In other words, if the sec-ch-ua-platform does not match, the Token cannot be used.
+This library uses the Linux Chrome header by default.
+To use Token issued by Windows, do the following.
+
+```python
+client = TwitterOpenapiPython()
+client.additional_api_headers = {
+  "sec-ch-ua-platform": '"Windows"',
+};
+```
+
+## License
+
+This project is dual licensed. You can choose one of the following licenses:
+
+- [Custom License](./LICENSE)
+- [GNU Affero General Public License v3.0](./LICENSE.AGPL)

twitter_openapi_python-0.0.27/twitter_openapi_python.egg-info/requires.txt

@@ -0,0 +1,2 @@
+twitter_openapi_python_generated==0.0.25
+pydantic>=2.6

twitter_openapi_python-0.0.24/PKG-INFO

@@ -1,15 +0,0 @@
-Metadata-Version: 2.1
-Name: twitter_openapi_python
-Version: 0.0.24
-Summary: Twitter OpenAPI
-Home-page: https://github.com/fa0311/twitter_openapi_python
-Author: fa0311
-Author-email: yuki@yuki0311.com
-License: proprietary or AGPL-3.0-or-later
-Keywords: OpenAPI,OpenAPI-Generator,Twitter OpenAPI
-Description-Content-Type: text/markdown
-License-File: LICENSE
-License-File: LICENSE.AGPL
-
-        Twitter scraping with data validation by pydantic.
-    

twitter_openapi_python-0.0.24/twitter_openapi_python.egg-info/PKG-INFO

@@ -1,15 +0,0 @@
-Metadata-Version: 2.1
-Name: twitter-openapi-python
-Version: 0.0.24
-Summary: Twitter OpenAPI
-Home-page: https://github.com/fa0311/twitter_openapi_python
-Author: fa0311
-Author-email: yuki@yuki0311.com
-License: proprietary or AGPL-3.0-or-later
-Keywords: OpenAPI,OpenAPI-Generator,Twitter OpenAPI
-Description-Content-Type: text/markdown
-License-File: LICENSE
-License-File: LICENSE.AGPL
-
-        Twitter scraping with data validation by pydantic.
-    

twitter_openapi_python-0.0.24/twitter_openapi_python.egg-info/requires.txt

@@ -1,2 +0,0 @@
-twitter_openapi_python_generated==0.0.21
-pydantic>=2.6