Table of contents

What is telegrambotapiwrapper?
Why telegrambotapiwrapper?
Requirements
Installation
Usage

• General remarks
• Types
• Methods
• Making requests
• Responses

Examples
FAQ
License
Contributing
Contacts

What is telegrambotapiwrapper?

telegrambotapiwrapper is Telegram Bot Api implementation for Python

Why telegrambotapiwrapper?

telegrambotapiwrapperis stable reliable implementation of Telegram Bot Api

Requirements

Python implementations

CPython

Python versions

3.7, 3.8, 3.9

Installation

pip install telegrambotapiwrapper

Usage

General remarks

• Implemented all methods Telegram Bot Api
• Implemented all types Telegram Bot Api

Types

      All types of Telegram Bot Api are imported from the typelib module.

For example:

>>> from telegrambotapiwrapper.typelib import User
>>> user = User(id=123456789, is_bot=False, first_name="UserFirstName")

      Types are all completely in line with the Telegram API's definition of the types, except for the Message's from field, which is renamed to from_ (because from is a Python keyword)

For example:

>>> from telegrambotapiwrapper.typelib import User, Message, Chat
>>> user = User(id=123456789, is_bot=False, first_name="UserFirstName")
>>> message = Message(
...    message_id=1234567891011,
...    date=987654321987,
...    chat=Chat(id=36725367325, type='group'),
...    from_=user # !
...)

Methods

       All Telegram Bot Api methods can be accessed through an instance of the Api class.       Methods are renamed to follow common Python naming conventions. E.g. getMe is renamed to get_me and sendMessage to send_message.

For example:

>>> from telegrambotapiwrapper import Api
>>> bot_api = Api(token="<paste your token here>")
>>> bot_api.send_message(chat_id=-321532153215, text="Hello world")

Making requests

Responses

      В случае успешного выполнения запроса, будет возвращено тот объект, который определен документацией для данного метода.
      Например, для в случае успешного выполнения метода sendMessage() будет возвращен объект Message.
      В случае неуспешного запроса будет выбрано сгенерировано исключение telegrambotapiwrapper.errors.UnsuccessfulRequest.

Экземпляр исключения UnsuccessfulRequest имеет в том числе и следующие атрибуты:

Attribute name	Optional	Explanation
description	No	Error explanation
error_code	No	Integer error code
parameters	Yes	Some errors may also have an optional field 'parameters' of the type ResponseParameters, which can help to automatically handle the error.

Для прояснения как генерируется данное исключение следует ознакомиться со следующей информацией:

From official Telegram documentation

The response contains a JSON object, which always has a Boolean field 'ok' and may have an optional String field 'description' with a human-readable description of the result. If 'ok' equals true, the request was successful and the result of the query can be found in the 'result' field. In case of an unsuccessful request, 'ok' equals false and the error is explained in the 'description'. An Integer 'error_code' field is also returned, but its contents are subject to change in the future. Some errors may also have an optional field 'parameters' of the type ResponseParameters, which can help to automatically handle the error.

Examples

1. Getting information about bot

>>> from telegrambotapiwrapper import Api
>>> first_bot_api = Api(token="<paste your token here>")
>>> me = first_bot_api.get_me()
>>> me
User(id=123456789, is_bot=True, first_name='botbotbot', last_name=None, username='ttesttesstttestbot', language_code=None)

Let's check the result type:

>>> from telegrambotapiwrapper.typelib import User
>>> isinstance(me, User)
True

2. Sending a photo to channel

>>> with open('/home/dzmitry/Pictures/500800998.jpg', 'rb') as image:
...    first_bot_api.send_photo(chat_id=-12345678912345, photo=image,
...                             caption="hello world")

>>>

Note the open file mode.

3. Sending a text message to channel

>>> first_bot_api.send_message(chat_id=-12345678912345, text="sdjfhjsdfbjdbvhj")
Message(message_id=299, date=1558966491, chat=Chat(id=--12345678912345, type='channel', title='FooFoo', username='lalalalalalala', first_name=None, last_name=None, all_members_are_administrators=None, photo=None, description=None, invite_link=None, pinned_message=None, sticker_set_name=None, can_set_sticker_set=None), from_user=None, forward_from=None, forward_from_chat=None, forward_from_message_id=None, forward_signature=None, forward_sender_name=None, forward_date=None, reply_to_message=None, edit_date=None, media_group_id=None, author_signature=None, text='sdjfhjsdfbjdbvhj', entities=None, caption_entities=None, audio=None, document=None, animation=None, game=None, photo=None, sticker=None, video=None, voice=None, video_note=None, caption=None, contact=None, location=None, venue=None, poll=None, new_chat_members=None, left_chat_member=None, new_chat_title=None, new_chat_photo=None, delete_chat_photo=None, group_chat_created=None, supergroup_chat_created=None, channel_chat_created=None, migrate_to_chat_id=None, migrate_from_chat_id=None, pinned_message=None, invoice=None, successful_payment=None, connected_website=None, passport_data=None)

Note that chat_id is negative.

4.

FAQ

License

MIT License Copyright (c) 2020 Dzmitry Maliuzhenets

See LICENSE for details.

Contributing

Feel free to contribute

Contacts

maliuzhenetsdzmitry @ gmail dot com