implement basic ding-dong bot #39

wj-Mcat · 2020-04-30T07:22:54Z

Implement python-wechaty message module, so it can receive and send message.

run example/ding-dong-bot.py, bot can say dong when it receive ding in personal chat, not in a Room.

wj-Mcat · 2020-04-30T07:56:04Z

This is the simplest version of python-wechaty. There are some problems:

chatie_grpc: I generate the grpc code locally and the genreated code can't pass code linting tools.
mypy: missing-import error, need to be fixed.

huan · 2020-04-30T09:31:13Z

That's a HUGE PR! Thank you so much for the efforts for pushing our ding-dong-bot.py moving forward!

I'm working on it now, and I hope I can give you some good feedback later.

huan

Hi @wj-Mcat ,

You did a great job of connecting the Wechaty with the GRPC service, I believe we are very close to the runnable ding-dong-bot.py!

This PR is a quite long one which includes lots of codes and API changes, I have some comments/suggestions/thoughts and have put some of them in the comments.

Please read them carefully and let me know what you think by reply to my comments under this PR so that we can start a conversation to make it clearer.

I believe there will be quite a number of questions that need to be discussed between us after you reply to my comments, so I'd like to suggest that we can schedule a short zoom meeting to have a discussion on it in person if you think it's necessary too.

requirements.txt

src/wechaty_puppet/file_box.py

src/wechaty_puppet/message.py

src/wechaty/user/image.py

src/wechaty/user/mini_program.py

src/wechaty/user/message.py

src/wechaty/user/room.py

src/wechaty/user/room_invitation.py

wj-Mcat · 2020-04-30T13:11:22Z

@huan I think it's necessary. see you tonight.

huan · 2020-04-30T16:57:45Z

Some links that we have talked about tonight:

Understanding the Wechaty Architecture for Hostie: go-wechaty implementation wechaty-puppet-hostie discussion. go-wechaty#22

The Puppet Server Architecture: https://github.com/wechaty/python-wechaty#python-wechaty-developing-plan

Node NPM FileBox Project: https://github.com/huan/file-box
Node NPM MemoryCard Project: https://github.com/huan/memory-card
PyPI(pip) packages to be published: PyPI(pip) packages to be published #43
Generate Puppet Schema from TypeScript Automatically: Generate Puppet Schema from TypeScript Automatically go-wechaty#26

huan · 2020-05-09T03:24:01Z

src/wechaty/user/contact.py

@@ -72,6 +72,21 @@ def __init__(self, contact_id: str):
        # self.name: str = "default_acontact"
        self.payload: Optional[ContactPayload] = None

+    _event_stream: AsyncIOEventEmitter = AsyncIOEventEmitter()


Are there any blockers that prevent we inherited Contact from the EventEmitter class?

At the beginning, I think that Contact/Room class should focus on logic processing. One module should be as simple as possible. If we add EventEmit ability to them, they look redundant. Although, I have not split the code. Besides，Event listener should be global function, not a member of a class.

For example, room-invite event should be a moduler function, don't couple with Contact/Room class.

# user/room.py class Room: pass # user/room_events.py def listen_room_invite(room: Room, inviter: Contact, ): # do some logic processing

But, If we put all things which is about room toRoom class, that also looks good to me. If I makeRoom inherited from AsyncIOEventEmitter , there is only a few code changes. So, it's simple to refactor code.

What do you think about it.

ic. Let's talk about it in today's meeting.

huan · 2020-05-09T06:16:26Z

examples/ding-dong-bot.py

+
+# puppet_options = PuppetOptions(token='your-token-here')
+hostie_puppet = HostiePuppet(PuppetOptions('your-token-here'), 'hostie-puppet')
+bot = Wechaty(hostie_puppet).on('message', message)


Can we use the same argument as the TypeScript Wechaty?

bot = Wechaty({ puppet: 'wechaty-puppet-hostie', puppetOptions: { token: 'the_token', }, })

Ok, I will refactor it later.

huan · 2020-05-09T06:37:47Z

src/wechaty/user/contact.py

-            log.info("can't load contact %s payload, message : %s",
-                     self.name,
-                     str(e.args))
+        if force_sync or self.is_ready():


I believe what you want to do is:

- if force_sync or self.is_ready(): + if force_sync or !self.is_ready():

Am I right?

And I'd like to suggest to following the following flow logic:

if self.is_ready() and not force_sync: return // Do the sync staffs

Because the above flow logic can save us for indent for the following codes.

I find this bug just now. I have changed it.
Thank you for giving me so detailed code view.

huan · 2020-05-09T06:48:12Z

src/wechaty/user/contact.py

-            return []
+        log.info('load contact tags for %s', self)
+        tag_ids = await self.puppet.tag_contact_list(self.contact_id)
+        tags = [self.wechaty.Tag.load(contact_id)


I don't think the Tag.load() can use a contact_id as it's argument.

huan · 2020-05-09T06:50:26Z

src/wechaty/user/friendship.py

-        self._payload = await self.puppet.friendship_payload(
-            self.friendship_id)
+        if not self.is_ready():
+            friendship_search_response = await self.puppet.friendship_payload(


Why the return data from puppet.friendship_payload() need to be converted again?

I believe it should be already the payload interface that we need already?

huan · 2020-05-09T06:56:28Z

src/wechaty/user/message.py

-            cls,
-            # need return type annotation
-            query: Union[str, MessageUserQueryFilter]):
+    async def find(cls, talker_id: Optional[str] = None,


A QueryFilter would be better for this argument.

huan · 2020-05-09T06:58:11Z

src/wechaty/user/message.py

@@ -381,10 +385,10 @@ async def mention_self(self) -> bool:
        Check if a message is mention self.
        :return:
        """
-        self_id = self.puppet.self_id()
+        self_id = self.wechaty.contact_id


I saw you have use xxx.get_wechaty() before, however, I'd like to prefer xxx.wechaty.yyy more because it looks clearer.

Please be consistent.

This module is designed very early. When I translate ts to python, I find a problem: python has no static property. So, we can't set inner static member as typescript. https://github.com/wechaty/wechaty/blob/master/src/accessory.ts#L30

If we keep consistent, xxx.wechaty is a static member, rather than a property which get/set inner static member.

I'm ok with either design of them.

Let's keep trying our best to keep consistent.

huan · 2020-05-09T07:11:08Z

src/wechaty_puppet/schemas/message.py

+from dataclasses import dataclass
+
+
+class MessageType(Enum):


Cloud we import all those constant values from the chatie-grpc module? Because that module is auto-generated from the chatie/grpc golden of the source repo.

wechaty_puppet is a abstract module which should not contains any thing in wechaty_puppet_** .

There will be many wechaty_puppet_**, which MessageType member value may be different. eg:

# wechaty_puppet_hostie class MessageType(Enum): Contact = 0 Text = 1 # wechaty_puppet_padplus class MessageType(Enum): Contact = 1 Text = 2

So, How to resolve different wechaty_puppet_** Enum constant value same as wechaty_puppet.
I think keep that using names to ensure consistency is a good solution:

# wechaty_puppet_chatie MESSAGE_TYPE_MAP = { ChatieMessageType.Contact: MessageType.Contact } # wechaty_puppet_padplus MESSAGE_TYPE_MAP = { PadPlusMessageType.Contact: MessageType.Contact }

So, use name-convention to keep same information.

How do think?

huan · 2020-05-09T07:12:51Z

src/wechaty_puppet/version.py

+limitations under the License.
+"""
+
+VERSION = '0.0.1'


please change to 0.0.0.

It should be auto-generated via the GitHub Actions before be published/deployed.

huan

Great progress!

LGTM.

huan · 2020-05-09T07:15:08Z

This is a HUGE Pull Request!

I'd like to suggest that we can merge this PR first, and then we can submit smaller PRs to continue working on our project.

Please let me know if you want to wait this PR to grow larger instead of merging it right now...

wj-Mcat · 2020-05-09T08:12:11Z

Yes, I think we should merge this pr, and split modules to me and @huangaszaq . So, we can push progress to be faster.

huan · 2020-05-09T08:17:59Z

Great to know that you agree with me to merge it!

Please use separate PR by creating different branches for different feature developments/bug fixes, because we can easily discuss different topics with focus.

Thank you for the great effort to push our Python Wechaty project moving forward, keep fighting!

huangaszaq · 2020-05-09T08:31:15Z

Six six six! LGTM! I have been studying ts these days, and may be ready to work on it.

wj-Mcat added 3 commits April 30, 2020 15:11

add pip packages to requirements.txt

e6e30f1

imp ding-dong bot

9b82908

update git config & ding-dong example

8e87f27

wj-Mcat requested a review from a team as a code owner April 30, 2020 07:22

update ding-dong-bot

b643e35

wj-Mcat requested a review from huan April 30, 2020 07:31

huan reviewed Apr 30, 2020

View reviewed changes

complete base puppet & puppet_hostie

aca6b59

huan reviewed May 9, 2020

View reviewed changes

huan previously approved these changes May 9, 2020

View reviewed changes

resolve asyncio loop bug

cc22602

wj-Mcat dismissed huan’s stale review via cc22602 May 9, 2020 08:13

Merge branch 'master' into master

3c898d0

huan merged commit af7f9f0 into wechaty:master May 9, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

implement basic ding-dong bot #39

implement basic ding-dong bot #39

wj-Mcat commented Apr 30, 2020

wj-Mcat commented Apr 30, 2020

huan commented Apr 30, 2020

huan left a comment

wj-Mcat commented Apr 30, 2020

huan commented Apr 30, 2020 •

edited

Loading

huan May 9, 2020

wj-Mcat May 9, 2020

huan May 9, 2020

huan May 9, 2020 •

edited

Loading

wj-Mcat May 9, 2020

huan May 9, 2020 •

edited

Loading

wj-Mcat May 9, 2020

huan May 9, 2020

huan May 9, 2020

huan May 9, 2020

huan May 9, 2020

wj-Mcat May 9, 2020

huan May 9, 2020

huan May 9, 2020

wj-Mcat May 9, 2020

huan May 9, 2020

huan left a comment

huan commented May 9, 2020

wj-Mcat commented May 9, 2020

huan commented May 9, 2020

huangaszaq commented May 9, 2020

implement basic ding-dong bot #39

implement basic ding-dong bot #39

Conversation

wj-Mcat commented Apr 30, 2020

wj-Mcat commented Apr 30, 2020

huan commented Apr 30, 2020

huan left a comment

Choose a reason for hiding this comment

wj-Mcat commented Apr 30, 2020

huan commented Apr 30, 2020 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

huan May 9, 2020 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

huan May 9, 2020 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

huan left a comment

Choose a reason for hiding this comment

huan commented May 9, 2020

wj-Mcat commented May 9, 2020

huan commented May 9, 2020

huangaszaq commented May 9, 2020

huan commented Apr 30, 2020 •

edited

Loading

huan May 9, 2020 •

edited

Loading

huan May 9, 2020 •

edited

Loading