Merge pull request #30 from wj-Mcat/master

enable dirty_payload abstract function to puppet

Author: univerone

VERSION

@@ -1 +1 @@
-0.0.17
+0.0.18

requirements.txt

@@ -1,4 +1,5 @@
 pyee
 requests
-chatie-grpc==0.16.1
+chatie-grpc>=0.17.dev4
 qrcode
+pylru

src/wechaty_puppet/puppet.py

@@ -52,17 +52,18 @@
     RoomPayload,
     RoomMemberPayload,
 
-    RoomInvitationPayload
+    RoomInvitationPayload,
+
+    PayloadType
 
 )
 
 
 class Puppet:
     """
-    puppet interface class
-
-    TODO -> StateSwitch schema
+    puppet interface class, which is the abstract of puppet implementation.
 
+    python-wechaty-puppet-XX can be all of the protocol of IM software.
     """
 
     def __init__(self, options: PuppetOptions, name: str = 'puppet'):
@@ -485,3 +486,9 @@ async def login(self, user_id: str):
         :return:
         """
         raise NotImplementedError
+
+    async def dirty_payload(self, payload_type: PayloadType, payload_id: str):
+        """
+        mark the payload dirty status, and remove
+        """
+        raise NotImplementedError

src/wechaty_puppet/schemas/types.py

@@ -49,6 +49,9 @@
 
     # Event
     EventType,
+
+    # Payload type
+    PayloadType
 )
 
 
@@ -70,5 +73,7 @@
 
     'ImageType',
 
-    'EventType'
+    'EventType',
+
+    'PayloadType'
 ]