wechaty / python-wechaty-puppet-service Goto Github PK

View Code? Open in Web Editor NEW

8.0 6.0 15.0 192 KB

Python Puppet Service Client for Wechaty

Home Page: https://pypi.org/project/wechaty-puppet-service

License: Apache License 2.0

Makefile 5.02% Python 94.98%

chatbot rpa sdk

python-wechaty-puppet-service's Introduction

wechaty-puppet-service

Python Service Puppet for Wechaty

Features

Consume Wechaty Puppet Service

Usage

import asyncio
from wechaty import Wechaty
from wechaty_puppet_service import PuppetService

bot = Wechaty(PuppetService("your-token-here"))
bot.on('message', lambda x: print(x))

asyncio.run(bot.start())

Environment Variables

1 `WECHATY_PUPPET_SERVICE_TOKEN`

The token set to this environment variable will become the default value of puppetOptions.token

WECHATY_PUPPET_SERVICE_TOKEN=secret python bot.py

or you can use TOKEN or token environment variable alias name to set token, for example:

TOKEN=secret python bot.py
# or
token=secret python bot.py

History

master

v0.7 (Mar, 2021)

Rename from wechaty-puppet-hostie -> wechaty-puppet-service

v0.0.1 (Mar 10, 2020)

Init Python version
Published to PyPI

Authors

@wj-Mcat - Jingjing WU (吴京京)
@huan - (李卓桓) [email protected]

Copyright & License

Code & Docs © 2020-now Huan LI <[email protected]>
Code released under the Apache-2.0 License
Docs released under Creative Commons

python-wechaty-puppet-service's People

Contributors

Stargazers

Watchers

Forkers

univerone fish-ball huangaszaq yangte1 resettingmq wj-mcat wolfreecn aiamber yangruihan alingse-forks maxiaoxifeng yoo-bit sir1st dwro0121 helloocc

python-wechaty-puppet-service's Issues

api error that occur during testing

data = await puppet.contact_alias(id='token', alias='mylove')

grpclib.exceptions.GRPCError: (<Status.INTERNAL: 13>, 'CacheManager getContact() has no cache.', None)

data = await puppet.contact_self_q_r_code()

grpclib.exceptions.GRPCError: (<Status.INTERNAL: 13>, 'Wechaty Puppet Unsupported API Error. Learn More At https://github.com/wechaty/wechaty-puppet/wiki/Compatibility', None)

room_qrcode = await puppet.room_q_r_code(id='room-id')

grpclib.exceptions.GRPCError: (<Status.INTERNAL: 13>, 'Wechaty Puppet Unsupported API Error. Learn More At https://github.com/wechaty/wechaty-puppet/wiki/Compatibility', None)

data = await puppet.contact_self_name(name='秋天')

grpclib.exceptions.GRPCError: (<Status.INTERNAL: 13>, 'Wechaty Puppet Unsupported API Error. Learn More At https://github.com/wechaty/wechaty-puppet/wiki/Compatibility', None)

data = await puppet.contact_self_signature()

grpclib.exceptions.GRPCError: (<Status.INTERNAL: 13>, 'Wechaty Puppet Unsupported API Error. Learn More At https://github.com/wechaty/wechaty-puppet/wiki/Compatibility', None)

some functions are not finished yet

There are some function are not finished yet

Welcome to contribute the pr.

Event 'room-join' / 'room-leave' Can't touch off

the room-join and room-leave can't touch off after 2020-07-24
bot = Wechaty().on('room-join', room_join)
bot = Wechaty().on('room-leave', room_leave)

failed send FileBox with stream Type

stream 模式的 FileBox 无法发送

@dataclass
class FileBoxOptionsStream(FileBoxOptionsBase):
    """
    stream file-box options
    """
    # TODO -> recheck the stream data type
    stream: bytes = b''
    type: FileBoxType = FileBoxType.Stream

而对应的

class FileBoxEncoder(json.JSONEncoder):
    def default(self, obj):
        if isinstance(obj, bytes):
            return str(obj, encoding='utf-8')

        return json.JSONEncoder.default(self, obj)

因为 stream 是二进制的，且不是 utf8 格式，所以这里转换会失败

ERROR:root:'utf-8' codec can't decode byte 0x89 in position 0: invalid start byte

所以我觉得 FileBoxEncoder 可以再改改。

我可以来提供 PR

Move init_puppet() from init() to start()

https://github.com/wechaty/python-wechaty-puppet-hostie/blob/b802e4b4c572adc67daca4bca0480be534dbc81f/src/wechaty_puppet_hostie/puppet.py#L92

Currently, we are initializing the GRPC inside __init__() which is an anti-pattern because it will make the module hard to test.

Please move the init_puppet() to the start() which it is a better place to do this job only after the start() was called.

when dealing with on_friendship, `internal error <list index out of range>` occurs

I'm trying to fix the bug wechaty/python-wechaty#74

And finally turns out that when the code run in to HostiePuppet.friendship_payload() the below error occured.

2020-06-25 19:28:48,885 - Wechaty - ERROR - internal error
ERROR:Wechaty:internal error

get into trouble with contact_avatar grpc method

When we call method from chatie-grpc:

response = await self.puppet_stub.contact_avatar(id=contact_id)

we will receive error :

2020-06-23 19:51:17,895 - Wechaty - ERROR - internal error <(<Status.INTERNAL: 13>, 'FileBox.toJSON() can only work on limited FileBoxType(s). See: <https://github.com/huan/file-box/issues/25>', None)>
ERROR:Wechaty:internal error <(<Status.INTERNAL: 13>, 'FileBox.toJSON() can only work on limited FileBoxType(s). See: <https://github.com/huan/file-box/issues/25>', None)>

It seems that this error is from hostie-server. @huan

Bug Report: forward message failed with UrlLink Message

Description

If there is UrlLink message to be forwarded, it will occur an error. It seems that there is a bug in message_forward method.

some puppet-hostie function has not been implemented

Please run the following command and check whether the problem has been fixed：

pip uninstall -r requirements.txt
pip install -r requirements.txt
python your-bot.py

there are some puppet-hostie functions which have not been implemented.

room_validate
room_payload_dirty
room_member_payload_dirty

there are some puppet-hostie functions which is not correct.

message_file
init_puppet

which should be with start function not in __init__ function . this is mentioned by Huan a few months ago.

room_search

I think there is an error: "can't not ping endpoint" in puppet.py (line:901) v0.8.3

I meet an error when it pings the end_point, error message:
I meet an error: wechaty_puppet.exceptions.WechatyPuppetConfigurationError: WechatyPuppetConfigurationError("can't not ping endpoint: [ip:port]", None, None)``

hostie stucked when connected to Wechaty Gateway Server with Padlocal token

Just switched to padlocal token.

Started my endpoint (gateway server). Got logs:

10:40:01 VERB Wechaty initPuppetEventBridge() puppet.on(error) (listenerCount:0) registering...
10:40:01 VERB Wechaty initPuppetEventBridge() puppet.on(heartbeat) (listenerCount:0) registering...
10:40:01 VERB Wechaty initPuppetEventBridge() puppet.on(ready) (listenerCount:0) registering...
10:40:01 VERB Wechaty initPuppetEventBridge() puppet.on(reset) (listenerCount:0) registering...
10:40:01 VERB Wechaty wechatifyUserModules(Puppet#0(mytokenxx123766x))
10:40:01 VERB StateSwitch on(pending) <- (false)
10:40:01 INFO
============================================================
Welcome to Wechaty PadLocal puppet!

   - wechaty-puppet-padlocal version: 0.2.3
   - padlocal-ts-client version: 0.2.3
  ============================================================

10:40:01 VERB Wechaty on(heartbeat, listener) registering... listenerCount: 1
10:40:01 VERB StateSwitch on(true) <- (pending)
10:40:01 VERB IoClient startHostie()
10:40:01 VERB PuppetServer constructor({endpoint: "0.0.0.0:9001", puppet: "Puppet#0(mytokenxxxxxx)", token: "mytokenxxxxxx"})
10:40:01 VERB PuppetServer start()
10:40:01 VERB EventStreamManager constructor(Puppet#0(mytokenxxxxxx))
10:40:01 VERB StateSwitch on(true) <- (pending)
10:40:01 VERB [PuppetPadlocal] start login with type: QrLogin
10:40:02 VERB [PuppetPadlocal] scan event, status: Waiting, with qrcode: http://weixin.qq.com/x/AbXxxxxxOXGBn
10:40:02 INFO IoClient [2] http://weixin.qq.com/x/AbXxxxxOXGBn
Online QR Code Image: https://wechaty.js.org/qrcode/http%3A%2F%2Fweixin.qq.com%2Fx%xxxxwXrlv-1OXGBn

On the python side, everything looks fine. But no QR code popped up. The hostile exit after stucking for a while.

I got logs:

2021-01-07 02:40:45,412 - Wechaty - INFO - init_puppet_event_bridge() <<wechaty_puppet_hostie.puppet.HostiePuppet object at 0x11f5e7b80>>
2021-01-07 02:40:45,412 - Wechaty - INFO - initPuppetEventBridge() puppet.on(dong) (listenerCount:1) registering...
2021-01-07 02:40:45,412 - Wechaty - INFO - initPuppetEventBridge() puppet.on(error) (listenerCount:1) registering...
2021-01-07 02:40:45,412 - Wechaty - INFO - initPuppetEventBridge() puppet.on(heart-beat) (listenerCount:1) registering...
2021-01-07 02:40:45,412 - Wechaty - INFO - initPuppetEventBridge() puppet.on(ready) (listenerCount:1) registering...
2021-01-07 02:40:45,412 - Wechaty - INFO - receive event <%s>
2021-01-07 02:40:45,412 - Wechaty - INFO - initPuppetEventBridge() puppet.on(reset) (listenerCount:0) registering...
2021-01-07 02:40:45,412 - Wechaty - INFO - initPuppetEventBridge() puppet.on(friendship) (listenerCount:1) registering...
2021-01-07 02:40:45,412 - Wechaty - INFO - initPuppetEventBridge() puppet.on(login) (listenerCount:1) registering...
2021-01-07 02:40:45,413 - Wechaty - INFO - initPuppetEventBridge() puppet.on(logout) (listenerCount:1) registering...
2021-01-07 02:40:45,413 - Wechaty - INFO - initPuppetEventBridge() puppet.on(message) (listenerCount:1) registering...
2021-01-07 02:40:45,413 - Wechaty - INFO - initPuppetEventBridge() puppet.on(room-invite) (listenerCount:1) registering...
2021-01-07 02:40:45,413 - Wechaty - INFO - initPuppetEventBridge() puppet.on(room-join) (listenerCount:1) registering...
2021-01-07 02:40:45,413 - Wechaty - INFO - initPuppetEventBridge() puppet.on(room-leave) (listenerCount:1) registering...
2021-01-07 02:40:45,413 - Wechaty - INFO - initPuppetEventBridge() puppet.on(room-topic) (listenerCount:1) registering...
2021-01-07 02:40:45,413 - Wechaty - INFO - initPuppetEventBridge() puppet.on(scan) (listenerCount:1) registering...
2021-01-07 02:40:45,413 - Wechaty - INFO - starting puppet ...
2021-01-07 02:40:45,413 - HostiePuppet - INFO - init puppet
2021-01-07 02:40:45,414 - HostiePuppet - INFO - starting the puppet ... <<<<< stucked here.
2021-01-07 02:43:16,481 - Wechaty - ERROR - The network is not good, the bot will try to restart after 60 seconds.
2021-01-07 02:44:16,486 - Wechaty - INFO - restarting the bot ...
2021-01-07 02:44:16,486 - Wechaty - INFO - wechaty is stoping ...
2021-01-07 02:44:16,486 - Wechaty - INFO - stopping - stop puppet
2021-01-07 02:44:16,486 - HostiePuppet - INFO - stop()

🐛🐛 Bug Report: There's a conflict about environment variables

When I have set WECHATY_PUPPET_SERVICE_TOKEN at my bashrc file, and I also set another token with my python code. It will always the former one.

pre-commit tool required.

As used in python-wechaty repo, pre-commit can keep every commit tested and bump a new version to track our changes. So, this tool is essential for python-wechaty.

Using ping will cause to raise an exception, but message missing

Hi, wechaty is awesome! Thanks for everything.

I got Wechaty - ERROR - The network is not good, the bot will try to restart after 60 seconds., when I start my custom boy with config WECHATY_PUPPET_SERVICE_ENDPOINT=127.0.0.1:xxxx.

I found this code cause it:

python-wechaty-puppet-service/src/wechaty_puppet_service/puppet.py

Lines 901 to 904 in 9b109f2

    
           if ping(self.options.end_point) is False: 
        
               raise WechatyPuppetConfigurationError( 
        
                   f"can't not ping endpoint: {self.options.end_point}" 
        
               )

ping('127.0.0.1') will raise an exception "permission denied", but exception message missing, It's not friendly.

ping3 pointer that should run as root.

[New Feature]Add grpc.default_authority option for authorization

I want to use grpc.default_authority to identify the current user.Could we add grpc.default_authority option to gRPC channel?

see:
wechaty/puppet-service#78
wechaty/go-wechaty#69
wechaty/java-wechaty#77

An internal error from function to_file_box()

function to_file_box() internal error

wechaty puppet version: wechaty docker 0.65
wechaty version: python wechaty 0.8.24
token: padlocal token

Description

Sometimes internal error will occur when saving image from receiver or talker, and then download file failed. Please take a look, thanks.

Reproduce your problem

SUPPORTED_MESSAGE_FILE_TYPES: List[MessageType] = [
    MessageType.MESSAGE_TYPE_ATTACHMENT,
    MessageType.MESSAGE_TYPE_IMAGE,
    MessageType.MESSAGE_TYPE_EMOTICON,
    MessageType.MESSAGE_TYPE_VIDEO,
    MessageType.MESSAGE_TYPE_AUDIO
]

async def on_message(self, msg: Message):
    if msg.type() in SUPPORTED_MESSAGE_FILE_TYPES:
        file_box = await msg.to_file_box()
        if file_box is not None:
            await file_box.to_file(file_box.name)

Error log

2021-08-28 20:15:36,517 - Wechaty - ERROR - internal error <(<Status.UNKNOWN: 2>, '[tid:1aff233b] [11014ms] download file failed:{"host":{"host":"180.111.198.203","port":80},"payload":"qwAAA4xOIFuIHZ0AAAAAAAAAAAAAAAADcwAAAAN2ZXIAAAABMQAAAAl3ZWl4aW5udW0AAAAKMjYzNTk1ODM2MwAAAANzZXEAAAABNgAAAA1jbGllbnR2ZXJzaW9uAAAACTQwMjY1NDc1NAAAAAxjbGllbnRvc3R5cGUAAAAMaVBhZCBpT1MxNC4yAAAAB2F1dGhrZXkAAABCMEACAQEEOTA3AgEBAgEBAgSdHYhbAgM9Ef0CAQACBOg+W2UCAz0UuQIEkbISDgIE6LISDgIEYXlClgIEbVqU7AQAAAAAB25ldHR5cGUAAAABMQAAAAxhY2NlcHRkdXBhY2sAAAABMQAAAAZyc2F2ZXIAAAABMQAAAAhyc2F2YWx1ZQAAAIA5RP1WFQnG6GSt8n34g7/QrAXe0hxxrQwIahtEzJgLFjoq9bVqCIq60e7kbQcC/nFtef/f8Q3DnY647etiCSEyPPEVlQZFYo96RFj4XUH38MRkiL1GY3KNaPMfuuwtXgCYss3bshcvSoZQ//wqmBG6PiCfHoezAlT7iXGe8k4MnAAAAAhmaWxldHlwZQAAAAEyAAAACnd4Y2hhdHR5cGUAAAABMAAAAAZmaWxlaWQAAAESMzA4MTg2MDIwMTAwMDQ3YTMwNzgwMjAxMDAwMjA0NWYzMThkYmMwMjAzMmY0ZjU2MDIwNDI2N2FjMmRjMDIwNDYxMmEyOGNjMDQ1Mzc3Nzg3NTcwNmM2ZjYxNjQ1ZjMxMzgzODM1MzEzMTM4MzczNTMxMzI0MDYzNjg2MTc0NzI2ZjZmNmQzMzMwMzIzMTM0MzA1ZjMxMzYzMzMwMzEzNTMyMzkzMDM3NWY2NDM3NjI2MjY0MzEzNDY1MmQzODY1NjI2NjJkMzQ2MzMwMzQyZDYxMzUzMDM1MmQzNzM1MzgzOTM3NjYzMzMwMzI2MTYyMzgwMjA0MDEyNTBhMDIwMjAxMDAwNDA1MDA0YzRjNmUwMAAAAAtsYXN0cmV0Y29kZQAAAAEwAAAABWlwc2VxAAAAATAAAAANY2xF1aWMtZmxhZwAAAAEwAAAACXd4bXNnZmxhZwAAAAAAAAALd3hhdXRvc3RhcnQAAAABMAAAAA1kb3ducGljZm9ybWF0AAAAATEAAAAGb2Zmc2V0AAAAATAAAAALbGFyZ2VzdmlkZW8AAAABMAAAAApzb3VyY2VmbGFnAAAAATA=","unpackaeskey":"3Pa/o8iamL8Gdoq3=="}, received null response', None)>

cache.lru_cache should be applied to functions

LUR cache strategy can relieve the pressure of IO, we can apply this feature to methods or attributes.
refet to :

	if ping(self.options.end_point) is False:
	raise WechatyPuppetConfigurationError(
	f"can't not ping endpoint: {self.options.end_point}"
	)

wechaty / python-wechaty-puppet-service Goto Github PK

python-wechaty-puppet-service's Introduction

wechaty-puppet-service

Features

Usage

Environment Variables

1 WECHATY_PUPPET_SERVICE_TOKEN

History

master

v0.7 (Mar, 2021)

v0.0.1 (Mar 10, 2020)

Authors

Copyright & License

python-wechaty-puppet-service's People

Contributors

Stargazers

Watchers

Forkers

python-wechaty-puppet-service's Issues

Description

function to_file_box() internal error

Description

Reproduce your problem

Error log

Recommend Projects

Recommend Topics

Recommend Org

1 `WECHATY_PUPPET_SERVICE_TOKEN`