mirror/pyTelegramBotAPI
1
0
Fork 0
mirror of https://github.com/eternnoir/pyTelegramBotAPI.git synced 2023-08-10 21:12:57 +03:00
Code Releases Activity

Update readme.rst.

Browse Source
This commit is contained in:
eternnoir 2015-09-05 18:13:47 +08:00
parent 93aa37768a
commit 149c54cc31
1 changed files with 432 additions and 268 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

670
README.rst
View File

@ -1,364 +1,528 @@
# <p align="center">pyTelegramBotAPI #
<p align="center">A simple, but extensible Python implementation for the [Telegram Bot API](https://core.telegram.org/bots/api). .. raw:: html
<p align="center">
<p align="center">[![Build Status](https://travis-ci.org/eternnoir/pyTelegramBotAPI.svg?branch=master)](https://travis-ci.org/eternnoir/pyTelegramBotAPI) pyTelegramBotAPI
* [Getting started.](#getting-started) .. raw:: html
* [Writing your first bot](#writing-your-first-bot)
* [Prerequisites](#prerequisites)
* [A simple echo bot](#a-simple-echo-bot)
* [General API Documentation](#general-api-documentation)
* [Types](#types)
* [Methods](#methods)
* [General use of the API](#general-use-of-the-api)
* [Message handlers](#message-handlers)
* [TeleBot](#telebot)
* [Reply markup](#reply-markup)
* [Advanced use of the API](#advanced-use-of-the-api)
* [Asynchronous delivery of messages](#asynchronous-delivery-of-messages)
* [Sending large text messages](#sending-large-text-messages)
* [Controlling the amount of Threads used by TeleBot](#controlling-the-amount-of-threads-used-by-telebot)
* [Don't stop when receiving an error](#dont-stop-when-receiving-an-error)
* [The listener mechanism](#the-listener-mechanism)
* [Using web hooks](#using-web-hooks)
* [Logging](#logging)
* [F.A.Q.](#faq)
* [How can I distinguish a User and a GroupChat in message.chat?](#how-can-i-distinguish-a-user-and-a-groupchat-in-messagechat)
* [The Telegram Chat Group](#the-telegram-chat-group)
* [More examples](#more-examples)
## Getting started. <p align="center">
This API is tested with Python 2.6, Python 2.7, Python 3.4, Pypy and Pypy 3. A simple, but extensible Python implementation for the `Telegram Bot
There are two ways to install the library: API <https://core.telegram.org/bots/api>`__.
* Installation using pip (a Python package manager)*: .. raw:: html
``` <p align="center">
$ pip install pyTelegramBotAPI
```
* Installation from source (requires git):
``` |Build Status|
$ git clone https://github.com/eternnoir/pyTelegramBotAPI.git
$ cd pyTelegramBotAPI - `Getting started. <#getting-started>`__
$ python setup.py install - `Writing your first bot <#writing-your-first-bot>`__
```
- `Prerequisites <#prerequisites>`__
- `A simple echo bot <#a-simple-echo-bot>`__
- `General API Documentation <#general-api-documentation>`__
- `Types <#types>`__
- `Methods <#methods>`__
- `General use of the API <#general-use-of-the-api>`__
- `Message handlers <#message-handlers>`__
- `TeleBot <#telebot>`__
- `Reply markup <#reply-markup>`__
- `Advanced use of the API <#advanced-use-of-the-api>`__
- `Asynchronous delivery of
messages <#asynchronous-delivery-of-messages>`__
- `Sending large text messages <#sending-large-text-messages>`__
- `Controlling the amount of Threads used by
TeleBot <#controlling-the-amount-of-threads-used-by-telebot>`__
- `The listener mechanism <#the-listener-mechanism>`__
- `Using web hooks <#using-web-hooks>`__
- `Logging <#logging>`__
- `F.A.Q. <#faq>`__
- `How can I distinguish a User and a GroupChat in
message.chat? <#how-can-i-distinguish-a-user-and-a-groupchat-in-messagechat>`__
- `The Telegram Chat Group <#the-telegram-chat-group>`__
- `More examples <#more-examples>`__
Getting started.
================
This API is tested with Python 2.6, Python 2.7, Python 3.4, Pypy and
Pypy 3. There are two ways to install the library:
- Installation using pip (a Python package manager)\*:
::
$ pip install pyTelegramBotAPI
- Installation from source (requires git):
::
$ git clone https://github.com/eternnoir/pyTelegramBotAPI.git
$ cd pyTelegramBotAPI
$ python setup.py install
It is generally recommended to use the first option. It is generally recommended to use the first option.
**While the API is production-ready, it is still under development and it has regular updates, do not forget to update it regularly by calling `pip install pytelegrambotapi --upgrade`* \*\*While the API is production-ready, it is still under development and
it has regular updates, do not forget to update it regularly by calling
``pip install pytelegrambotapi --upgrade``\ \*
## Writing your first bot Writing your first bot
======================
### Prerequisites Prerequisites
-------------
It is presumed that you [have obtained an API token with @BotFather](https://core.telegram.org/bots#botfather). We will call this token `TOKEN`. It is presumed that you [have obtained an API token with
Furthermore, you have basic knowledge of the Python programming language and more importantly [the Telegram Bot API](https://core.telegram.org/bots/api). @BotFather](https://core.telegram.org/bots#botfather). We will call this
token ``TOKEN``. Furthermore, you have basic knowledge of the Python
programming language and more importantly `the Telegram Bot
API <https://core.telegram.org/bots/api>`__.
### A simple echo bot A simple echo bot
-----------------
The TeleBot class (defined in \__init__.py) encapsulates all API calls in a single class. It provides functions such as `send_xyz` (`send_message`, `send_document` etc.) and several ways to listen for incoming messages. The TeleBot class (defined in \_\_init\_\_.py) encapsulates all API
calls in a single class. It provides functions such as ``send_xyz``
(``send_message``, ``send_document`` etc.) and several ways to listen
for incoming messages.
Create a file called `echo_bot.py`. Create a file called ``echo_bot.py``. Then, open the file and create an
Then, open the file and create an instance of the TeleBot class. instance of the TeleBot class.
```python
import telebot .. code:: python
import telebot
bot = telebot.TeleBot("TOKEN")
bot = TeleBot("TOKEN")
```
*Note: Make sure to actually replace TOKEN with your own API token.* *Note: Make sure to actually replace TOKEN with your own API token.*
After that declaration, we need to register some so-called message handlers. Message handlers define filters which a message must pass. If a message passes the filter, the decorated function is called and the incoming message is passed as an argument. After that declaration, we need to register some so-called message
handlers. Message handlers define filters which a message must pass. If
a message passes the filter, the decorated function is called and the
incoming message is passed as an argument.
Let's define a message handler which handles incoming `/start` and `/help` commands. Let's define a message handler which handles incoming ``/start`` and
```python ``/help`` commands.
@bot.message_handler(commands=['start', 'help'])
def send_welcome(message): .. code:: python
@bot.message_handler(commands=['start', 'help'])
def send_welcome(message):
bot.reply_to(message, "Howdy, how are you doing?") bot.reply_to(message, "Howdy, how are you doing?")
```
A function which is decorated by a message handler __can have an arbitrary name, however, it must have only one parameter (the message)__. A function which is decorated by a message handler **can have an
arbitrary name, however, it must have only one parameter (the
message)**.
Let's add another handler: Let's add another handler:
```python
@bot.message.handler(func=lambda m: True) .. code:: python
def echo_all(message):
@bot.message_handler(func=lambda m: True)
def echo_all(message):
bot.reply_to(message, message.text) bot.reply_to(message, message.text)
```
This one echoes all incoming text messages back to the sender. This one echoes all incoming text messages back to the sender. It uses a
lambda function to test a message. If the lambda returns True, the
message is handled by the decorated function. Since we want all messages
to be handled by this function, we simply always return True.
*Note: all handlers are tested in the order in which they were declared* *Note: all handlers are tested in the order in which they were declared*
We now have a basic bot which replies a static message to "/start" and "/help" commands and echoes the rest of the sent messages back. To start the bot, add the following to our source file: We now have a basic bot which replies a static message to "/start" and
```python "/help" commands and which echoes the rest of the sent messages. To
bot.polling() start the bot, add the following to our source file:
import time .. code:: python
while True:
time.sleep(100) bot.polling()
```
The last three lines are necessary to keep the process alive. If they were to be omitted, the program would terminate as soon as bot.polling() is called. They have no impact on the bot's functioning.
Alright, that's it! Our source file now looks like this: Alright, that's it! Our source file now looks like this:
```python
import telebot
bot = TeleBot("TOKEN") .. code:: python
@bot.message_handler(commands=['start', 'help']) import telebot
def send_welcome(message):
bot = telebot.TeleBot("TOKEN")
@bot.message_handler(commands=['start', 'help'])
def send_welcome(message):
bot.reply_to(message, "Howdy, how are you doing?") bot.reply_to(message, "Howdy, how are you doing?")
@bot.message.handler(func=lambda m: True) @bot.message_handler(func=lambda message: True)
def echo_all(message): def echo_all(message):
bot.reply_to(message, message.text) bot.reply_to(message, message.text)
bot.polling() bot.polling()
import time To start the bot, simply open up a terminal and enter
while True: ``python echo_bot.py`` to run the bot! Test it by sending commands
time.sleep(100) ('/start' and '/help') and arbitrary text messages.
```
To start the bot, simply open up a terminal and enter `python echo_bot.py` to run the bot! Test it by sending commands ('/start' and '/help') and arbitrary text messages.
## General API Documentation General API Documentation
=========================
### Types Types
-----
All types are defined in types.py. They are all completely in line with the [Telegram API's definition of the types](https://core.telegram.org/bots/api#available-types), except for the Message's `from` field, which is renamed to `from_user` (because `from` is a Python reserved token). Thus, attributes such as `message_id` can be accessed directly with `message.message_id`. Note that `chat` can be either an instance of `User` or `GroupChat`. All types are defined in types.py. They are all completely in line with
the `Telegram API's definition of the
types <https://core.telegram.org/bots/api#available-types>`__, except
for the Message's ``from`` field, which is renamed to ``from_user``
(because ``from`` is a Python reserved token). Thus, attributes such as
``message_id`` can be accessed directly with ``message.message_id``.
Note that ``message.chat`` can be either an instance of ``User`` or
``GroupChat`` (see `How can I distinguish a User and a GroupChat in
message.chat? <#how-can-i-distinguish-a-user-and-a-groupchat-in-messagechat>`__).
### Methods The Message object also has a ``content_type``\ attribute, which defines
the type of the Message. ``content_type`` can be one of the following
strings: 'text', 'audio', 'document', 'photo', 'sticker', 'video',
'location', 'contact', 'new\_chat\_participant',
'left\_chat\_participant', 'new\_chat\_title', 'new\_chat\_photo',
'delete\_chat\_photo', 'group\_chat\_created'.
All [API methods](https://core.telegram.org/bots/api#available-methods) are located in the TeleBot class. They are renamed to follow common Python naming conventions. E.g. `getMe` is renamed to `get_me` and `sendMessage` to `send_message`. Methods
-------
### General use of the API All `API
methods <https://core.telegram.org/bots/api#available-methods>`__ are
located in the TeleBot class. They are renamed to follow common Python
naming conventions. E.g. ``getMe`` is renamed to ``get_me`` and
``sendMessage`` to ``send_message``.
General use of the API
----------------------
Outlined below are some general use cases of the API. Outlined below are some general use cases of the API.
#### Message handlers Message handlers
A message handler is a function which is decorated with the `message_handler` decorator of a TeleBot instance. The following examples illustrate the possibilities of message handlers: ~~~~~~~~~~~~~~~~
```python
import telebot
bot = telebot.TeleBot("TOKEN")
# Handles all text messages that contains the commands '/start' or '/help'. A message handler is a function which is decorated with the
@bot.message_handler(commands=['start', 'help']) ``message_handler`` decorator of a TeleBot instance. The following
def handle_start_help(message): examples illustrate the possibilities of message handlers:
.. code:: python
import telebot
bot = telebot.TeleBot("TOKEN")
# Handles all text messages that contains the commands '/start' or '/help'.
@bot.message_handler(commands=['start', 'help'])
def handle_start_help(message):
pass pass
# Handles all sent documents and audio files # Handles all sent documents and audio files
@bot.message_handler(content_types=['document', 'audio']) @bot.message_handler(content_types=['document', 'audio'])
def handle_docs_audio(message): def handle_docs_audio(message):
pass pass
# Handles all text messages that match the regular expression # Handles all text messages that match the regular expression
@bot.message_handler(regexp="SOME_REGEXP") @bot.message_handler(regexp="SOME_REGEXP")
def handle_message(message): def handle_message(message):
pass pass
#Handles all messages for which the lambda returns True #Handles all messages for which the lambda returns True
@bot.message_handler(func=lambda message: message.document.mime_type == 'text/plain', content_types=['document']) @bot.message_handler(func=lambda message: message.document.mime_type == 'text/plain', content_types=['document'])
def handle_text_doc(message): def handle_text_doc(message):
pass pass
#Which could also be defined as: #Which could also be defined as:
def test_message(message): def test_message(message):
return message.document.mime_type == 'text/plan' return message.document.mime_type == 'text/plan'
@bot.message_handler(func=test_message, content_types=['document']) @bot.message_handler(func=test_message, content_types=['document'])
def handle_text_doc(message) def handle_text_doc(message)
pass pass
```
*Note: all handlers are tested in the order in which they were declared* *Note: all handlers are tested in the order in which they were declared*
#### TeleBot #### TeleBot
```python
import telebot
TOKEN = '<token_string>' .. code:: python
tb = telebot.TeleBot(TOKEN) #create a new Telegram Bot object
# getMe import telebot
user = tb.get_me()
# sendMessage TOKEN = '<token_string>'
tb.send_message(chatid, text) tb = telebot.TeleBot(TOKEN) #create a new Telegram Bot object
# forwardMessage # Upon calling this function, TeleBot starts polling the Telegram servers for new messages.
tb.forward_message(to_chat_id, from_chat_id, message_id) # - none_stop: True/False (default False) - Don't stop polling when receiving an error from the Telegram servers
# - interval: True/False (default False) - The interval between polling requests
# Note: Editing this parameter harms the bot's response time
# - block: True/False (default True) - Blocks upon calling this function
tb.polling(none_stop=False, interval=0, block=True)
# sendPhoto with a File # getMe
photo = open('/tmp/photo.png', 'rb') user = tb.get_me()
tb.send_photo(chat_id, photo)
# sendAudio # getUpdates
audio = open('/tmp/audio.mp3', 'rb') updates = tb.get_updates()
tb.send_audio(chat_id, audio) updates = tb.get_updates(1234,100,20) #get_Updates(offset, limit, timeout):
## sendAudio with duration, performer and title. # sendMessage
tb.send_audio(CHAT_ID, file_data, 1, 'eternnoir', 'pyTelegram') tb.send_message(chatid, text)
# sendVoice # forwardMessage
voice = open('/tmp/voice.ogg', 'rb') tb.forward_message(to_chat_id, from_chat_id, message_id)
tb.send_voice(chat_id, voice)
# sendDocument # All send_xyz functions which can take a file as an argument, can also take a file_id instead of a file.
doc = open('/tmp/file.txt', 'rb') # sendPhoto
tb.send_document(chat_id, doc) photo = open('/tmp/photo.png', 'rb')
tb.send_photo(chat_id, photo)
tb.send_photo(chat_id, "FILEID")
# sendSticker # sendAudio
sti = open('/tmp/sti.webp', 'rb') audio = open('/tmp/audio.mp3', 'rb')
tb.send_sticker(chat_id, sti) tb.send_audio(chat_id, audio)
tb.send_audio(chat_id, "FILEID")
# sendVideo ## sendAudio with duration, performer and title.
video = open('/tmp/video.mp4', 'rb') tb.send_audio(CHAT_ID, file_data, 1, 'eternnoir', 'pyTelegram')
tb.send_video(chat_id, video)
# sendLocation # sendVoice
tb.send_location(chat_id, lat, lon) voice = open('/tmp/voice.ogg', 'rb')
tb.send_voice(chat_id, voice)
tb.send_voice(chat_id, "FILEID")
# sendChatAction # sendDocument
# action_string can be one of the following strings: 'typing', 'upload_photo', 'record_video', 'upload_video', doc = open('/tmp/file.txt', 'rb')
# 'record_audio', 'upload_audio', 'upload_document' or 'find_location'. tb.send_document(chat_id, doc)
tb.send_chat_action(chat_id, action_string) tb.send_document(chat_id, "FILEID")
```
#### Reply markup
All `send_xyz` functions of TeleBot take an optional `reply_markup` argument. This argument must be an instance of `ReplyKeyboardMarkup`, `ReplyKeyboardHide` or `ForceReply`, which are defined in types.py.
```python # sendSticker
from telebot import types sti = open('/tmp/sti.webp', 'rb')
tb.send_sticker(chat_id, sti)
tb.send_sticker(chat_id, "FILEID")
# Use the ReplyKeyboardMarkup class. # sendVideo
# It's constructor can take the following optional arguments: video = open('/tmp/video.mp4', 'rb')
# - resize_keyboard: True/False (default False) tb.send_video(chat_id, video)
# - one_time_keyboard: True/False (default False) tb.send_video(chat_id, "FILEID")
# - selective: True/False (default False)
# - row_width: integer (default 3)
# row_width is used in combination with the add() function.
# It defines how many buttons are fit on each row before continuing on the next row.
markup = types.ReplyKeyboardMarkup(row_width=2)
markup.add('a', 'v', 'd')
tb.send_message(chat_id, message, reply_markup=markup)
# or add strings one row at a time: # sendLocation
markup = types.ReplyKeyboardMarkup() tb.send_location(chat_id, lat, lon)
markup.row('a', 'v')
markup.row('c', 'd', 'e')
tb.send_message(chat_id, message, reply_markup=markup)
# Using ReplyKeyboardHide # sendChatAction
# Takes an optional selective argument (True/False, default False) # action_string can be one of the following strings: 'typing', 'upload_photo', 'record_video', 'upload_video',
markup = types.ReplyKeyboardHide(selective=False) # 'record_audio', 'upload_audio', 'upload_document' or 'find_location'.
tb.send_message(chat_id, message, reply_markup=markup) tb.send_chat_action(chat_id, action_string)
# Using ForceReply Reply markup
# Takes an optional selective argument (True/False, default False) ~~~~~~~~~~~~
markup = types.ForceReply(selective=False)
tb.send_message(chat_id, message, reply_markup=markup)
```
## Advanced use of the API All ``send_xyz`` functions of TeleBot take an optional ``reply_markup``
argument. This argument must be an instance of ``ReplyKeyboardMarkup``,
``ReplyKeyboardHide`` or ``ForceReply``, which are defined in types.py.
### Asynchronous delivery of messages .. code:: python
There exists an implementation of TeleBot which executes all `send_xyz` and the `get_me` functions asynchronously. This can speed up you bot __significantly__, but it has unwanted side effects if used without caution.
To enable this behaviour, create an instance of AsyncTeleBot instead of TeleBot.
```python
tb = telebot.AsyncTeleBot("TOKEN")
```
Now, every function that calls the Telegram API is executed in a separate Thread. The functions are modified to return an AsyncTask instance (defined in \__init__.py). Using AsyncTeleBot allows you to do the following:
```python
import telebot
tb = AsyncTeleBot("TOKEN") from telebot import types
task = tb.get_me() # Execute an API call
# Do some other operations... # Using the ReplyKeyboardMarkup class
a = 0 # It's constructor can take the following optional arguments:
for a in range(100): # - resize_keyboard: True/False (default False)
# - one_time_keyboard: True/False (default False)
# - selective: True/False (default False)
# - row_width: integer (default 3)
# row_width is used in combination with the add() function.
# It defines how many buttons are fit on each row before continuing on the next row.
markup = types.ReplyKeyboardMarkup(row_width=2)
markup.add('a', 'v', 'd')
tb.send_message(chat_id, "Choose one letter:", reply_markup=markup)
# or add strings one row at a time:
markup = types.ReplyKeyboardMarkup()
markup.row('a', 'v')
markup.row('c', 'd', 'e')
tb.send_message(chat_id, "Choose one letter:", reply_markup=markup)
The last example yields this result:
.. figure:: https://pp.vk.me/c624430/v624430512/473e5/_mxxW7FPe4U.jpg
:alt: ReplyKeyboardMarkup
ReplyKeyboardMarkup
.. code:: python
# ReplyKeyboardHide: hides a previously sent ReplyKeyboardMarkup
# Takes an optional selective argument (True/False, default False)
markup = types.ReplyKeyboardHide(selective=False)
tb.send_message(chat_id, message, reply_markup=markup)
.. code:: python
# ForceReply: forces a user to reply to a message
# Takes an optional selective argument (True/False, default False)
markup = types.ForceReply(selective=False)
tb.send_message(chat_id, "Send me another word:", reply_markup=markup)
ForceReply:
.. figure:: https://pp.vk.me/c624430/v624430512/473ec/602byyWUHcs.jpg
:alt: ForceReply
ForceReply
Advanced use of the API
=======================
Asynchronous delivery of messages
---------------------------------
There exists an implementation of TeleBot which executes all
``send_xyz`` and the ``get_me`` functions asynchronously. This can speed
up you bot **significantly**, but it has unwanted side effects if used
without caution. To enable this behaviour, create an instance of
AsyncTeleBot instead of TeleBot.
.. code:: python
tb = telebot.AsyncTeleBot("TOKEN")
Now, every function that calls the Telegram API is executed in a
separate Thread. The functions are modified to return an AsyncTask
instance (defined in util.py). Using AsyncTeleBot allows you to do the
following:
.. code:: python
import telebot
tb = telebot.AsyncTeleBot("TOKEN")
task = tb.get_me() # Execute an API call
# Do some other operations...
a = 0
for a in range(100):
a += 10 a += 10
result = task.wait() # Get the result of the execution result = task.wait() # Get the result of the execution
```
*Note: if you execute send_xyz functions after eachother without calling wait(), the order in which messages are delivered might be wrong.*
### Sending large text messages *Note: if you execute send\_xyz functions after eachother without
Sometimes you must send messages that exceeds 5000 characters. The Telegram API can not handle that many characters at a time, so we need to split the message in multiples. Here is how to do that using the API: calling wait(), the order in which messages are delivered might be
```python wrong.*
from telebot import apihelper
large_text = open("large_text.txt", "rb").read() Sending large text messages
splitted_text = apihelper.split_string(large_text, 3000) ---------------------------
for text in splitted_text:
Sometimes you must send messages that exceed 5000 characters. The
Telegram API can not handle that many characters in one request, so we
need to split the message in multiples. Here is how to do that using the
API:
.. code:: python
from telebot import util
large_text = open("large_text.txt", "rb").read()
# Split the text each 3000 characters.
# split_string returns a list with the splitted text.
splitted_text = util.split_string(large_text, 3000)
for text in splitted_text:
tb.send_message(chat_id, text) tb.send_message(chat_id, text)
```
### Controlling the amount of Threads used by TeleBot Controlling the amount of Threads used by TeleBot
-------------------------------------------------
The TeleBot constructor takes the following optional arguments: The TeleBot constructor takes the following optional arguments:
- create_threads: True/False (default True). A flag to indicate whether TeleBot should execute message handlers on it's polling Thread.
- num_threads: integer (default 4). Controls the amount of WorkerThreads created for the internal thread pool that TeleBot uses to execute message handlers. Is not used when create_threads is False.
### Don't stop when receiving an error - create\_threads: True/False (default True). A flag to indicate
TeleBot's `polling()` function takes an optional none_stop argument. When none_stop equals True, the bot will not exit when it receives an invalid response from the Telegram API servers. none_stop defaults to False. whether TeleBot should execute message handlers on it's polling
Example: `tb.polling(none_stop=True)` Thread.
- num\_threads: integer (default 4). Controls the amount of
WorkerThreads created for the internal thread pool that TeleBot uses
to execute message handlers. Is not used when create\_threads is
False.
*Note: You should take caution when using this, because some errors (e.g. if the Telegram servers fail to return data) can not be ignored and the bot would malfunction.* The listener mechanism
----------------------
### The listener mechanism As an alternative to the message handlers, one can also register a
As an alternative to the message handlers, one can also register a function as a listener to TeleBot. Example: function as a listener to TeleBot. Example:
```python
def handle_messages(message): .. code:: python
def handle_messages(messages):
for message in messsages: for message in messsages:
# Do something with the message # Do something with the message
bot.reply_to(message, 'hi') bot.reply_to(message, 'Hi')
bot.set_update_listener(handle_messages) bot.set_update_listener(handle_messages)
bot.polling() bot.polling()
```
### Using web hooks Using web hooks
If you prefer using web hooks to the getUpdates method, you can use the `process_new_messages(messages)` function in TeleBot to make it process the messages that you supply. It takes a list of Message objects. ---------------
### Logging If you prefer using web hooks to the getUpdates method, you can use the
``process_new_messages(messages)`` function in TeleBot to make it
process the messages that you supply. It takes a list of Message
objects. This function is still incubating.
Now you can use Telebot module logger to log some information in Telebot. Use `telebot.logger` to get the Logging
Telebot module logger. -------
```python You can use the Telebot module logger to log debug info about Telebot.
logger = telebot.logger Use ``telebot.logger`` to get the logger of the TeleBot module.
formatter = logging.Formatter('[%(asctime)s] %(thread)d {%(pathname)s:%(lineno)d} %(levelname)s - %(message)s',
.. code:: python
logger = telebot.logger
formatter = logging.Formatter('[%(asctime)s] %(thread)d {%(pathname)s:%(lineno)d} %(levelname)s - %(message)s',
'%m-%d %H:%M:%S') '%m-%d %H:%M:%S')
ch = logging.StreamHandler(sys.stdout) ch = logging.StreamHandler(sys.stdout)
logger.addHandler(ch) logger.addHandler(ch)
logger.setLevel(logging.DEBUG) # or use logging.INFO logger.setLevel(logging.DEBUG) # or use logging.INFO
ch.setFormatter(formatter) ch.setFormatter(formatter)
```
## F.A.Q. F.A.Q.
======
How can I distinguish a User and a GroupChat in message.chat?
-------------------------------------------------------------
### How can I distinguish a User and a GroupChat in message.chat?
There are two ways to do this: There are two ways to do this:
- Checking the instance of message.chat with `isinstance`: - Checking the instance of message.chat with ``isinstance``:
```python \`\`\`python def is\_user(chat): return isinstance(chat, types.User)
def is_user(chat):
return isinstance(chat, types.User)
print is_user(message.chat) # True or False print is\_user(message.chat) # True or False
``` ``- Checking whether the chat id is negative or positive. If the chat id is negative, the chat is a GroupChat, if it is positive, it is a User. Example:``\ python
- Checking whether the chat id is negative or positive. If the chat id is negative, the chat is a GroupChat, if it is positive, it is a User. Example: def is\_user(chat): return chat.id > 0
```python
def is_user(chat):
return chat.id > 0
print is_user(message.chat) # True or False print is\_user(message.chat) # True or False \`\`\`
```
## The Telegram Chat Group The Telegram Chat Group
=======================
Get help. Discuss. Chat. Get help. Discuss. Chat.
Join the [pyTelegramBotAPI Telegram Chat Group](https://telegram.me/joinchat/067e22c60035523fda8f6025ee87e30b). Join the `pyTelegramBotAPI Telegram Chat
Group <https://telegram.me/joinchat/067e22c60035523fda8f6025ee87e30b>`__.
## More examples More examples
=============
* [Echo Bot](https://github.com/eternnoir/pyTelegramBotAPI/blob/master/examples/echo_bot.py) - `Echo
* [Deep Linking](https://github.com/eternnoir/pyTelegramBotAPI/blob/master/examples/deep_linking.py) Bot <https://github.com/eternnoir/pyTelegramBotAPI/blob/master/examples/echo_bot.py>`__
* [next_step_handler Example](https://github.com/eternnoir/pyTelegramBotAPI/blob/master/examples/step_example.py) - `Deep
Linking <https://github.com/eternnoir/pyTelegramBotAPI/blob/master/examples/deep_linking.py>`__
- `next\_step\_handler
Example <https://github.com/eternnoir/pyTelegramBotAPI/blob/master/examples/step_example.py>`__
.. |Build Status| image:: https://travis-ci.org/eternnoir/pyTelegramBotAPI.svg?branch=master
:target: https://travis-ci.org/eternnoir/pyTelegramBotAPI