ui_metrics

Author: d60

README.md

@@ -83,9 +83,10 @@ client = Client('en-US')
 
 async def main():
     await client.login(
-        auth_info_1=USERNAME ,
+        auth_info_1=USERNAME,
         auth_info_2=EMAIL,
-        password=PASSWORD
+        password=PASSWORD,
+        cookies_file='cookies.json'
     )
 
 asyncio.run(main())

docs/requirements.txt

@@ -5,4 +5,5 @@ beautifulsoup4
 pyotp
 lxml
 webvtt-py
-m3u8
+m3u8
+js2py

requirements.txt

@@ -4,4 +4,5 @@ beautifulsoup4
 pyotp
 lxml
 webvtt-py
-m3u8
+m3u8
+js2py

twikit/__init__.py

@@ -7,7 +7,7 @@
 A Python library for interacting with the Twitter API.
 """
 
-__version__ = '2.3.0'
+__version__ = '2.3.1'
 
 import asyncio
 import os

twikit/client/client.py

@@ -4,7 +4,6 @@
 import io
 import json
 import os
-import re
 
 import warnings
 from functools import partial
@@ -40,13 +39,13 @@
 )
 from ..geo import Place, _places_from_response
 from ..group import Group, GroupMessage
-from ..js_metrics import run_js_metrics
 from ..list import List
 from ..message import Message
 from ..notification import Notification
 from ..streaming import Payload, StreamingSession, _payload_from_data
 from ..trend import Location, PlaceTrend, PlaceTrends, Trend
 from ..tweet import CommunityNote, Poll, ScheduledTweet, Tweet, tweet_from_data
+from ..ui_metrics import solve_ui_metrics
 from ..user import User
 from ..utils import (
     Flow,
@@ -291,7 +290,7 @@ async def login(
         password: str,
         totp_secret: str | None = None,
         cookies_file: str | None = None,
-        enable_ui_metrics: bool = False
+        enable_ui_metrics: bool = True
     ) -> dict:
         """
         Logs into the account using the specified login information.
@@ -319,11 +318,9 @@ async def login(
             The file path used for storing and loading cookies.
             If the specified file exists, cookies will be loaded from it, potentially bypassing the login process.
             After a successful login, cookies will be saved to this file for future use.
-        enable_ui_metrics : :class:`bool`, default=False
-            If set to True, obfuscated ui_metrics function will be executed using JSDom,
-            and the results will be sent to the API. Enabling this may reduce the risk of account suspension.
-            To use this feature, Node.js and JSDom must be installed.
-            If Node.js is available in your environment, enabling this option is recommended.
+        enable_ui_metrics : :class:`bool`, default=True
+            If set to True, obfuscated ui_metrics function will be executed using js2py,
+            and the result will be sent to the API. Enabling this may reduce the risk of account suspension.
 
         Examples
         --------
@@ -399,7 +396,7 @@ async def login(
         await flow.sso_init('apple')
 
         if enable_ui_metrics:
-            ui_metrics_response = run_js_metrics(
+            ui_metrics_response = solve_ui_metrics(
                 await self._ui_metrics()
             )
         else:

twikit/js_metrics/__init__.py

@@ -0,0 +1,22 @@
+import re
+
+import js2py
+
+from .dom import MockDocument
+
+FUNCTION_PATTERN = re.compile(r'function [a-zA-Z]+\(\) ({.+})')
+EQUAL_PATTERN = re.compile(r'(![a-zA-Z]{5}\|\|[a-zA-Z]{5})==([a-zA-Z]{5})')
+
+
+def solve_ui_metrics(ui_metrics: str) -> str:
+    match = FUNCTION_PATTERN.search(ui_metrics)
+    if not match:
+        raise ValueError()
+    inner_function = match.group(1)
+    # Replace '==' with '===' to ensure proper object comparison in js2py
+    inner_function = EQUAL_PATTERN.sub(r'\1===\2', inner_function)
+    context = js2py.EvalJs()
+    context.document = MockDocument()
+    function = 'function main()' + inner_function
+    context.eval(function)
+    return str(context.main())

twikit/ui_metrics/__init__.py

@@ -0,0 +1,52 @@
+from __future__ import annotations
+
+from typing import Callable
+
+
+class MockElement:
+    def __init__(self, tag_name, document: MockDocument) -> None:
+        self.tagName = tag_name
+        self.document = document
+        self.parentNode: MockElement | None = None
+
+    def appendChild(self, child: MockElement) -> None:
+        child.parentNode = self
+
+    def remove(self) -> None:
+        self.document.element_seq.remove(self)
+
+    def removeChild(self, child: MockElement) -> None:
+        child.remove()
+
+    @property
+    def lastElementChild(self) -> MockElement:
+        return self.children[-1]
+
+    def setAttribute(self, name: str, value: str) -> None:
+        pass
+
+    @property
+    def children(self) -> list[MockElement]:
+        return self.document._filter_elements(lambda x: x.parentNode == self)
+
+
+class MockDocument:
+    def __init__(self) -> None:
+        self.element_seq: list[MockElement] = []
+        self.createElement('body')
+
+    def createElement(self, tag_name) -> MockElement:
+        element = MockElement(tag_name, self)
+        self.element_seq.append(element)
+        return element
+
+    def _filter_elements(self, function: Callable[[MockElement], list[MockElement]]) -> list[MockElement]:
+        return list(
+            filter(
+                function,
+                self.element_seq
+            )
+        )
+
+    def getElementsByTagName(self, tag_name):
+        return self._filter_elements(lambda x: x.tagName == tag_name)