Package: hitchat
itchat is an open source api for WeChat, a commonly-used Chinese social networking app.Accessing your personal wechat account through itchat in python has never been easier.A wechat robot can handle all the basic messages with only less than 30 lines of codes.And it’s similiar to itchatmp (api for wechat massive platform), learn once and get two tools.Now Wechat is an important part of personal life, hopefully this repo can help you extend your personal wechat account’s functionality and enbetter user’s experience with wechat.InstallationpipinstallitchatSimple usesWith itchat, if you want to send a message to filehelper, this is how:importitchatitchat.auto_login()itchat.send('Hello, filehelper',toUserName='filehelper')And you only need to write this to reply personal text messages.importitchat@itchat.msg_register(itchat.content.TEXT)deftext_reply(msg):returnmsg.textitchat.auto_login()itchat.run()For more advanced uses you may continue on reading or browse thedocument.TryYou may have a try of the robot based on this project first:Here is thecode.Advanced usesSpecial usage of message dictionaryYou may find out that all the users and messages of itchat are dictionaries by printing them out onto the screen.But actually they are useful classes itchat created.They have useful keys and useful interfaces, like:@itchat.msg_register(TEXT)def_(msg):# equals to print(msg['FromUserName'])print(msg.fromUserName)And like:author=itchat.search_friends(nickName='LittleCoder')[0]author.send('greeting, littlecoder!')Message register of various typesThe following is a demo of how itchat is configured to fetch and reply daily information.importitchat,timefromitchat.contentimport*@itchat.msg_register([TEXT,MAP,CARD,NOTE,SHARING])deftext_reply(msg):msg.user.send('%s:%s'%(msg.type,msg.text))@itchat.msg_register([PICTURE,RECORDING,ATTACHMENT,VIDEO])defdownload_files(msg):msg.download(msg.fileName)typeSymbol={PICTURE:'img',VIDEO:'vid',}.get(msg.type,'fil')return'@%s@%s'%(typeSymbol,msg.fileName)@itchat.msg_register(FRIENDS)defadd_friend(msg):msg.user.verify()msg.user.send('Nice to meet you!')@itchat.msg_register(TEXT,isGroupChat=True)deftext_reply(msg):ifmsg.isAt:msg.user.send(u'@%s\u2005I received:%s'%(msg.actualNickName,msg.text))itchat.auto_login(True)itchat.run(True)Command line QR CodeYou can access the QR Code in command line through using this command:itchat.auto_login(enableCmdQR=True)Because of width of some character differs from systems, you may adjust the enableCmdQR to fix the problem.# for some linux system, width of block character is one instead of two, so enableCmdQR should be 2itchat.auto_login(enableCmdQR=2)Default background color of command line is dark (black), if it’s not, you may set enableCmdQR to be negative:itchat.auto_login(enableCmdQR=-1)Hot reloadBy using the following command, you may reload the program without re-scan QRCode in some time.itchat.auto_login(hotReload=True)User searchBy usingsearch_friends, you have four ways to search a user:Get your own user informationGet user information throughUserNameGet user information whose remark name or wechat account or nickname matches name key of the functionGet user information whose remark name, wechat account and nickname match what are given to the functionWay 3, 4 can be used together, the following is the demo program:# get your own user informationitchat.search_friends()# get user information of specific usernameitchat.search_friends(userName='@abcdefg1234567')# get user information of function 3itchat.search_friends(name='littlecodersh')# get user information of function 4itchat.search_friends(wechatAccount='littlecodersh')# combination of way 3, 4itchat.search_friends(name='LittleCoder机器人',wechatAccount='littlecodersh')There are detailed information about searching and getting of massive platforms and chatrooms in document.Download and send attachmentsThe attachment download function of itchat is in Text key of msgName of the file (default name of picture) is in FileName key of msgDownload function accept one location value (include the file name) and store attachment accordingly.@itchat.msg_register([PICTURE,RECORDING,ATTACHMENT,VIDEO])defdownload_files(msg):msg.download(msg.fileName)itchat.send('@%s@%s'%('img'ifmsg['Type']=='Picture'else'fil',msg['FileName']),msg['FromUserName'])return'%sreceived'%msg['Type']If you don’t want a local copy of the picture, you may pass nothing to the function to get a binary string.@itchat.msg_register([PICTURE,RECORDING,ATTACHMENT,VIDEO])defdownload_files(msg):withopen(msg.fileName,'wb')asf:f.write(msg.download())Multi instanceYou may use the following commands to open multi instance.importitchatnewInstance=itchat.new_instance()newInstance.auto_login(hotReload=True,statusStorageDir='newInstance.pkl')@newInstance.msg_register(itchat.content.TEXT)defreply(msg):returnmsg['Text']newInstance.run()Set callback after login and logoutCallback of login and logout are set throughloginCallbackandexitCallback.importtimeimportitchatdeflc():print('finish login')defec():print('exit')itchat.auto_login(loginCallback=lc,exitCallback=ec)time.sleep(3)itchat.logout()If loginCallback is not set, qr picture will be deleted and cmd will be cleared.If you exit through phone, exitCallback will also be called.FAQQ: Why I can’t send files whose name is encoded in utf8?A: That’s because of the upload setting of requests, you can putthis file(for py3 you needthis) into packages/urllib3 of requests package.Q: How to use this package to use my wechat as an monitor?A: There are two ways: communicate with your own account or with filehelper.Q: Why sometimes I can’t send messages?A: Some account simply can’t send messages to yourself, so usefilehelperinstead.CommentsIf you have any problems or suggestions, you can talk to me in thisissueOr ongitter.