OpenSource/python-telegram-bot
OpenSource/python-telegram-bot
1
0
Fork 0
mirror of https://github.com/python-telegram-bot/python-telegram-bot.git synced 2024-12-21 22:15:09 +01:00
Code Issues Projects Releases Packages Wiki Activity
Page: Ask Right
Pages
Adding defaults to your bot Arbitrary callback_data Architecture Ask Right Ask Support Avoiding flood limits Bot API Forward Compatibility Bots built with PTB Builder Pattern Code snippets Concurrency Emoji Examples Exception Handling Exceptions, Warnings and Logging Extensions Advanced Filters Extensions JobQueue Extensions Your first Bot Extensions – Advanced Filters Extensions – JobQueue Extensions – Your first Bot Frequently Asked Questions Frequently requested design patterns Handling network errors Home Hosting your bot InlineKeyboard Example Internal test bots Introduction to the API Local Bot API Server MWE Making your bot persistent Notes about GAE Google App Engine PTB test writing knowledge base Performance Optimizations Press Project Bots, Groups and Channels Related Projects Storing bot, user and chat related data Storing user and chat related data Telegram Passport Transition guide to Version 12.0 Transition guide to Version 13.0 Transition guide to Version 20.0 Transition guide to Version 4.0 Transition guide to Version 5.0 Type Checking Types of Handlers Webhooks Where to host Telegram Bots Working Behind a Proxy Working with Files and Media Writing Tests
12 Ask Right
Bibo-Joshi edited this page 2024-08-08 23:52:15 +02:00
Table of Contents

How to ask good technical questions

When working with PTB, you will sooner or later have a question. And that's fine! You can only expand your knowledge by asking questions and getting answers. This article is about how to ask good questions, focusing on questions appearing when working with PTB. Before we begin, please try to keep one rule of thumb in mind:

You want something from somebody else, so please put some effort in it.

Putting effort in it makes it easier for others to actually help you and it's more pleasant for both sides ;)

Errors/questions can appear on a lot of different levels and need to be addressed differently.

General Python questions & Questions about other libraries

When you're coding a bot, you will have to code a lot of stuff that doesn't actually have to do anything with PTB, i.e. the backend. Maybe you're also using other python libraries.

Please be aware that neither the PTBs user group on Telegram nor the issue tracker on PTBs GitHub repository are the right place to ask those questions.

Design Questions

Many questions are not about how to use a specific method/class of PTB, but more along the lines "If a users does this, I want my bot to react like that. What can I use for that?". When asking how to build a specific functionality with PTB, please try to describe it precisely and include all relevant information. Answering the following questions usually is a good starting point:

  1. What kind of event should trigger the functionality? Possible triggers are e.g.
    • User sends a message containing a command/specific expression/an image/…
    • A new member joins the group
    • A user presses an InlineKeyboardButton
    • A specific time of the day
    • Bot starts running
  2. What kind of chat is the functionality supposed to work in? A private chat with the bot? A group/supergroup? Or a channel?
  3. Is your Bot an Admin in that Chat?
  4. How do you want your bot to react?

A Bad Example:

How do I verify a user?

A Good Example:

When a new user enters a group, where my bot is an admin, I would like to verify that they are not spam bots by having them fill out some kind of captcha, preferably in the private chat with the bot. If the captcha is not filled out correctly within one day, they should be banned. I can already send a captcha message and also check if it was filled out correctly. What I can't figure out is how to catch users joining the group and how I can set up a delayed ban.

Questions on PTB

You have set up your bot - but something doesn't work. An update is not processed as you would expect it to be or you're encountering an error. Again, please try to be precise and include all relevant information. This means:

  1. What would you expect to happen? Usually this includes
  • What kind of update are you processing? Message, InlineQuery, CallbackQuery, …?
  • What kind of handler did you set up to handle this? What is it supposed to do?
  1. What is actually happening?
  • If you're encountering an exception, please provide the full traceback
  • Make sure that you activate logging or an error handler so that you can actually see the traceback!
  1. Where exactly are things going south? If you can locate the line/s of code that are misbehaving, please include them in your question.

If you have a hard time laying your finger on where exactly things go south, it might be helpful to provide a minimal working example.

A Bad Example:

The bot does not work and the messages do not connect to me.

A Good Example:

When using my bot in private it responds to all messages as expected. When I add it to a group, it doesn't, although I don't see any error messages in the log. How can I fix this?

Must read

  1. Introduction to the API
  2. Tutorial: Your first bot
  3. FAQ
  4. How to ask good questions
  5. How to write an MWE

Concepts & Important Elements

  1. Architecture Overview
  2. Builder Pattern for Application
  3. Types of Handlers
  4. Working with Files and Media
  5. Exceptions, Warnings and Logging
  6. Concurrency in PTB

Notable Features

  1. Advanced Filters
  2. Storing data
  3. Making your bot persistent
  4. Adding Defaults
  5. Job Queue
  6. Arbitrary callback_data
  7. Avoiding flood limits
  8. Webhooks
  9. Bot API Forward Compatiblity

Code Resources

  1. Frequently requested design patterns
  2. Code snippets
  3. Performance Optimizations
  4. Telegram Passport
  5. Bots built with PTB
  6. Automated Bot Tests

Examples explained

  1. InlineKeyboard Example

Networking

  1. Working Behind a Proxy
  2. Handling network errors

Other resources

  1. Where to host Telegram Bots
  2. How to host your bot
  3. Local API Server
  4. Type Checking with PTB
  5. Press
  6. Notes on GAE
  7. Related Projects
  8. Emoji

Transition Guides

Administration