Increment version

: make it possible to select whether to get only top chat.

MANIFEST.in

@@ -3,5 +3,4 @@ include requirements_test.txt
 prune testrun*.py
 prune log.txt
 prune quote.txt
-prune .gitignore
-prun tests
+prune .gitignore

pytchat/__init__.py

@@ -2,7 +2,7 @@
 pytchat is a python library for fetching youtube live chat without using yt api, Selenium, or BeautifulSoup.
 """
 __copyright__    = 'Copyright (C) 2019 taizan-hokuto'
-__version__      = '0.0.4.3'
+__version__      = '0.0.4.6'
 __license__      = 'MIT'
 __author__       = 'taizan-hokuto'
 __author_email__ = '55448286+taizan-hokuto@users.noreply.github.com'

pytchat/core_async/livechat.py

@@ -63,6 +63,9 @@ class LiveChatAsync:
     force_replay : bool  
         Trueの場合、ライブチャットが取得できる場合であっても
         強制的にアーカイブ済みチャットを取得する。
+    
+    topchat_only : bool
+        Trueの場合、上位チャットのみ取得する。
           
     Attributes
     ---------
@@ -81,7 +84,8 @@ class LiveChatAsync:
                 done_callback = None,
                 exception_handler = None,
                 direct_mode = False,
-                force_replay = False
+                force_replay = False,
+                topchat_only = False
                 ): 
         self.video_id  = video_id
         self.seektime = seektime
@@ -102,6 +106,7 @@ class LiveChatAsync:
         self._setup()
         self._first_fetch = True
         self._fetch_url = "live_chat/get_live_chat?continuation="
+        self._topchat_only = topchat_only
         if not LiveChatAsync._setup_finished:
             LiveChatAsync._setup_finished = True
             if exception_handler == None:
@@ -200,7 +205,8 @@ class LiveChatAsync:
             '''
             self._pauser.put_nowait(None)
             if not self._is_replay:
-                continuation = liveparam.getparam(self.video_id,3)
+                continuation = liveparam.getparam(
+                    self.video_id, 3, self._topchat_only)
         return continuation
 
     async def _get_contents(self, continuation, session, headers):
@@ -222,7 +228,8 @@ class LiveChatAsync:
                 self._parser.is_replay = True
                 self._fetch_url = ("live_chat_replay/"  
                     "get_live_chat_replay?continuation=")
-                continuation = arcparam.getparam(self.video_id, self.seektime)
+                continuation = arcparam.getparam(
+                    self.video_id, self.seektime, self._topchat_only)
                 livechat_json = (await  self._get_livechat_json(
                     continuation, session, headers))
                 contents = self._parser.get_contents(livechat_json)

pytchat/core_multithread/livechat.py

@@ -60,6 +60,9 @@ class LiveChat:
         Trueの場合、ライブチャットが取得できる場合であっても
         強制的にアーカイブ済みチャットを取得する。
 
+    topchat_only : bool
+        Trueの場合、上位チャットのみ取得する。
+        
     Attributes
     ---------
     _executor : ThreadPoolExecutor
@@ -80,7 +83,8 @@ class LiveChat:
                 callback = None,
                 done_callback = None,
                 direct_mode = False,
-                force_replay = False
+                force_replay = False,
+                topchat_only  = False
                 ):
         self.video_id  = video_id
         self.seektime = seektime
@@ -100,8 +104,8 @@ class LiveChat:
         self._pauser.put_nowait(None)
         self._setup()
         self._first_fetch = True
-        self._fetch_url = "live_chat/get_live_chat?continuation="
-
+        self._fetch_url = "live_chat/get_live_chat?continuation=",
+        self._topchat_only = topchat_only
         if not LiveChat._setup_finished:
             LiveChat._setup_finished = True
             if interruptable:

pytchat/paramgen/arcparam.py

@@ -52,8 +52,8 @@ def _nval(val):
     buf += val.to_bytes(1,'big')
     return buf
 
-def _build(video_id, seektime, topchatonly = False):
-    switch_01 = b'\x04' if topchatonly else b'\x01'
+def _build(video_id, seektime, topchat_only):
+    switch_01 = b'\x04' if topchat_only else b'\x01'
     if seektime < 0:
         times =_nval(0)
         switch = b'\x04'       
@@ -102,12 +102,14 @@ def _build(video_id, seektime, topchatonly = False):
                 ).decode()
             )
 
-def getparam(video_id, seektime = 0):
+def getparam(video_id, seektime = 0, topchat_only = False):
     '''
     Parameter
     ---------
     seektime : int
         unit:seconds
         start position of fetching chat data.
+    topchat_only : bool
+        if True, fetch only 'top chat'
     '''
-    return _build(video_id, seektime)
+    return _build(video_id, seektime, topchat_only)

pytchat/paramgen/liveparam.py

@@ -66,9 +66,9 @@ def _nval(val):
     buf += val.to_bytes(1,'big')
     return buf
 
-def _build(video_id, _ts1, _ts2, _ts3, _ts4, _ts5, topchatonly = False):
+def _build(video_id, _ts1, _ts2, _ts3, _ts4, _ts5, topchat_only):
     #_short_type2
-    switch_01 = b'\x04' if topchatonly else b'\x01'
+    switch_01 = b'\x04' if topchat_only else b'\x01'
     parity = _tzparity(video_id, _ts1^_ts2^_ts3^_ts4^_ts5)
 
     header_magic= b'\xD2\x87\xCC\xC8\x03'
@@ -155,12 +155,14 @@ def _times(past_sec):
     return list(map(lambda x:int(x*1000000),[_ts1,_ts2,_ts3,_ts4,_ts5]))
 
 
-def getparam(video_id,past_sec = 0):
+def getparam(video_id, past_sec = 0, topchat_only = False):
     '''
     Parameter
     ---------
     past_sec : int
         seconds to load past chat data
+    topchat_only : bool
+        if True, fetch only 'top chat'
     '''
-    return _build(video_id,*_times(past_sec))
+    return _build(video_id,*_times(past_sec),topchat_only)
 

pytchat/processors/compatible/renderer/currency.py

@@ -33,5 +33,6 @@ symbols = {
     "ARS\xa0": {"fxtext": "ARS", "jptext": "アルゼンチン・ペソ"},
     "CLP\xa0": {"fxtext": "CLP", "jptext": "チリ・ペソ"},
     "NOK\xa0": {"fxtext": "NOK", "jptext": "ノルウェー・クローネ"},
-    "BAM\xa0": {"fxtext": "BAM", "jptext": "ボスニア・兌換マルカ"}
+    "BAM\xa0": {"fxtext": "BAM", "jptext": "ボスニア・兌換マルカ"},
+    "SGD\xa0": {"fxtext": "SGD", "jptext": "シンガポール・ドル"}
 }

pytchat/processors/default/renderer/currency.py

@@ -33,5 +33,6 @@ symbols = {
     "ARS\xa0": {"fxtext": "ARS", "jptext": "アルゼンチン・ペソ"},
     "CLP\xa0": {"fxtext": "CLP", "jptext": "チリ・ペソ"},
     "NOK\xa0": {"fxtext": "NOK", "jptext": "ノルウェー・クローネ"},
-    "BAM\xa0": {"fxtext": "BAM", "jptext": "ボスニア・兌換マルカ"}
+    "BAM\xa0": {"fxtext": "BAM", "jptext": "ボスニア・兌換マルカ"},
+    "SGD\xa0": {"fxtext": "SGD", "jptext": "シンガポール・ドル"}
 }

setup.py

@@ -54,7 +54,7 @@ setup(
     long_description_content_type='text/markdown',
     license=license,
     install_requires=_requirements(),
-    tests_require=_test_requirements(),
+    #tests_require=_test_requirements(),
     description="a python library for fetching youtube live chat.",
     classifiers=[
         'Natural Language :: Japanese',

tests/test_compatible_processor.py

@@ -124,6 +124,21 @@ def test_superchat(mocker):
     assert "LCC." in ret["items"][0]["id"] 
     assert ret["items"][0]["snippet"]["type"]=="superChatEvent"
 
+def test_unregistered_currency(mocker):
+    processor = CompatibleProcessor()
+
+    _json = _open_file("tests/testdata/unregistered_currency.json")
+
+    _, chatdata = parser.parse(parser.get_contents(json.loads(_json)))
+
+    data = {
+        "video_id" : "",
+        "timeout" : 7,
+        "chatdata" : chatdata
+    }
+    ret = processor.process([data])
+    assert ret["items"][0]["snippet"]["superChatDetails"]["currency"] == "[UNREGISTERD]"
+
 
 def _open_file(path):
     with open(path,mode ='r',encoding = 'utf-8') as f:

tests/test_liveparam.py

@@ -4,6 +4,6 @@ from pytchat.paramgen import liveparam
 def test_liveparam_0(mocker):
     _ts1= 1546268400
     param = liveparam._build("01234567890",
-    *([_ts1*1000000 for i in range(5)]))
+    *([_ts1*1000000 for i in range(5)]), topchat_only=False)
     test_param="0ofMyAPiARp8Q2c4S0RRb0xNREV5TXpRMU5qYzRPVEFhUTZxNXdiMEJQUW83YUhSMGNITTZMeTkzZDNjdWVXOTFkSFZpWlM1amIyMHZiR2wyWlY5amFHRjBQM1k5TURFeU16UTFOamM0T1RBbWFYTmZjRzl3YjNWMFBURWdBZyUzRCUzRCiAuNbVqsrfAjAAOABAAkorCAEQABgAIAAqDnN0YXRpY2NoZWNrc3VtOgBAAEoCCAFQgLjW1arK3wJYA1CAuNbVqsrfAliAuNbVqsrfAmgBggEECAEQAIgBAKABgLjW1arK3wI%3D"
     assert test_param == param

tests/testdata/unregistered_currency.json

@@ -0,0 +1,160 @@
+{
+  "timing": {
+    "info": {
+      "st": 164
+    }
+  },
+  "csn": "",
+  "response": {
+    "responseContext": {
+      "serviceTrackingParams": [{
+        "service": "CSI",
+        "params": [{
+          "key": "GetLiveChat_rid",
+          "value": ""
+        }, {
+          "key": "c",
+          "value": "WEB"
+        }, {
+          "key": "cver",
+          "value": "2.20191219.03.01"
+        }, {
+          "key": "yt_li",
+          "value": "0"
+        }]
+      }, {
+        "service": "GFEEDBACK",
+        "params": [{
+          "key": "e",
+          "value": ""
+        }, {
+          "key": "logged_in",
+          "value": "0"
+        }]
+      }, {
+        "service": "GUIDED_HELP",
+        "params": [{
+          "key": "logged_in",
+          "value": "0"
+        }]
+      }, {
+        "service": "ECATCHER",
+        "params": [{
+          "key": "client.name",
+          "value": "WEB"
+        }, {
+          "key": "client.version",
+          "value": "2.2"
+        }, {
+          "key": "innertube.build.changelist",
+          "value": "228"
+        }, {
+          "key": "innertube.build.experiments.source_version",
+          "value": "2858"
+        }, {
+          "key": "innertube.build.label",
+          "value": "youtube.ytfe.innertube_"
+        }, {
+          "key": "innertube.build.timestamp",
+          "value": "154"
+        }, {
+          "key": "innertube.build.variants.checksum",
+          "value": "e"
+        }, {
+          "key": "innertube.run.job",
+          "value": "ytfe-innertube-replica-only.ytfe"
+        }]
+      }],
+      "webResponseContextExtensionData": {
+        "ytConfigData": {
+          "csn": "ADw",
+          "visitorData": "%3D%3D"
+        }
+      }
+    },
+    "continuationContents": {
+      "liveChatContinuation": {
+        "continuations": [{
+          "timedContinuationData": {
+            "timeoutMs": 10000,
+            "continuation": "continuation"
+          }
+        }],
+        "actions": [{
+            "addChatItemAction": {
+              "item": {
+                "liveChatPaidMessageRenderer": {
+                  "id": "dummy_id",
+                  "timestampUsec": "1576850000000000",
+                  "authorName": {
+                    "simpleText": "author_name"
+                  },
+                  "authorPhoto": {
+                    "thumbnails": [
+                      {
+                        "url": "https://yt3.ggpht.com/------------/AAAAAAAAAAA/AAAAAAAAAAA/xxxxxxxxxxxx/s32-x-x-xx-xx-xx-c0xffffff/photo.jpg",
+                        "width": 32,
+                        "height": 32
+                      },
+                      {
+                        "url": "https://yt3.ggpht.com/------------/AAAAAAAAAAA/AAAAAAAAAAA/xxxxxxxxxxxx/s32-x-x-xx-xx-xx-c0xffffff/photo.jpg",
+                        "width": 64,
+                        "height": 64
+                      }
+                    ]
+                  },
+                  "purchaseAmountText": {
+                    "simpleText": "[UNREGISTERD]10,800"
+                  },
+                  "message": {
+                    "runs": [
+                      {
+                        "text": "This is unregistered currency."
+                      }
+                    ]
+                  },
+                  "headerBackgroundColor": 4291821568,
+                  "headerTextColor": 4294967295,
+                  "bodyBackgroundColor": 4293271831,
+                  "bodyTextColor": 4294967295,
+                  "authorExternalChannelId": "http://www.youtube.com/channel/author_channel_url",
+                  "authorNameTextColor": 3019898879,
+                  "contextMenuEndpoint": {
+                    "commandMetadata": {
+                      "webCommandMetadata": {
+                        "ignoreNavigation": true
+                      }
+                    },
+                    "liveChatItemContextMenuEndpoint": {
+                      "params": "___params___"
+                    }
+                  },
+                  "timestampColor": 2164260863,
+                  "contextMenuAccessibility": {
+                    "accessibilityData": {
+                      "label": "コメントの操作"
+                    }
+                  }
+                }
+              }, "clientId": "00000000000000000000"
+            }
+          }
+      ]}
+    },
+        
+    "xsrf_token": "xsrf_token",
+    "url": "/live_chat/get_live_chat?continuation=0",
+    "endpoint": {
+      "commandMetadata": {
+        "webCommandMetadata": {
+          "url": "/live_chat/get_live_chat?continuation=0",
+          "rootVe": 0
+        }
+      },
+      "urlEndpoint": {
+        "url": "/live_chat/get_live_chat?continuation=0"
+      }
+    }
+  }
+}
+