Merge pull request #3 from GeneralYadoc/develop

Use dataclass for args of constructor.

Author: GeneralYadoc

README.md

@@ -62,10 +62,13 @@ You can select from following ways.
       exit(0)
 
     # Create StreamChatAgent instance.
-    agent = sca.StreamChatAgent( video_id=sys.argv[1],
-                                 get_item_cb=get_item_cb,
-                                 pre_filter_cb=pre_filter_cb,
-                                 post_filter_cb=post_filter_cb )
+    params = sca.params(
+      video_id = sys.argv[1],
+      get_item_cb = get_item_cb,
+      pre_filter_cb = pre_filter_cb,
+      post_filter_cb = post_filter_cb
+    )
+    agent = sca.StreamChatAgent( params )
 
     # Start async getting YouTube chat items.
     # Then get_item_cb is called continuosly.
@@ -91,8 +94,8 @@ You can select from following ways.
     2023-05-19 05:21:27 [Kelly]- Hello everyone!
     2023-05-19 05:21:27 [Taro]- Welcome to our stream.
     ```
-## Arguments of Constractor
-- StreamChatAgent object can be configured with following arguments of its constractor.
+## Params given to Constructor
+- StreamChatAgent object can be configured with following params given to constructor.
 
     | name | description | default |
     |------|------------|---------|

samples/sample.py

@@ -28,10 +28,13 @@ def post_filter_cb(c):
   exit(0)
 
 # Create StreamChatAgent instance.
-agent = sca.StreamChatAgent( video_id=sys.argv[1],
-                             get_item_cb=get_item_cb,
-                             pre_filter_cb=pre_filter_cb,
-                             post_filter_cb=post_filter_cb )
+params = sca.params(
+  video_id = sys.argv[1],
+  get_item_cb = get_item_cb,
+  pre_filter_cb = pre_filter_cb,
+  post_filter_cb = post_filter_cb
+)
+agent = sca.StreamChatAgent( params )
 
 # Start async getting YouTube chat items.
 # Then get_item_cb is called continuosly.

setup.py

@@ -12,7 +12,7 @@ def _requires_from_file(filename):
 
 setup(
     name="streamchat-agent",
-    version="0.0.1",
+    version="1.0.0",
     license="MIT",
     description="Get YouTube chat comments with minimum time lag",
     author="General Yadoc",

src/StreamChatAgent.py

@@ -3,23 +3,28 @@
 import queue
 import math
 import pytchat
+from typing import Callable
+from dataclasses import dataclass
+
+@dataclass
+class params:
+  video_id: str
+  get_item_cb: Callable[[any,],None]
+  pre_filter_cb: Callable[[any,],any] = None
+  post_filter_cb: Callable[[any,],any] = None
+  max_queue_size: int = 1000
+  interval_sec: float = 0.01
 
 class StreamChatAgent(threading.Thread):
-  def __init__( self,
-                video_id,
-                get_item_cb,
-                pre_filter_cb=None,
-                post_filter_cb=None,
-                max_queue_size=1000,
-                interval_sec=0.01 ):
-    self.__get_item_cb = get_item_cb
-    self.__pre_filter_cb = pre_filter_cb
-    self.__post_filter_cb = post_filter_cb
-    self.__item_queue = queue.Queue(max_queue_size)
-    self.__interval_sec = interval_sec
+  def __init__( self, params ):
+    self.__get_item_cb = params.get_item_cb
+    self.__pre_filter_cb = params.pre_filter_cb
+    self.__post_filter_cb = params.post_filter_cb
+    self.__item_queue = queue.Queue(params.max_queue_size)
+    self.__interval_sec = params.interval_sec
     self.__keeping_connection = False
 
-    self.__chat = pytchat.create(video_id=video_id)
+    self.__chat = pytchat.create(video_id=params.video_id)
 
     self.__my_put_thread = threading.Thread(target=self.__put_items)
     self.__my_get_thread = threading.Thread(target=self.__get_items)

src/__init__.py

@@ -1,3 +1,3 @@
 from .StreamChatAgent import *
 
-__version__ = '0.0.1'
+__version__ = '1.0.0'