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-11-23 07:38:58 +01:00
Code Issues Projects Releases Packages Wiki Activity
Page: Type Checking
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
5 Type Checking
Bibo-Joshi edited this page 2022-05-06 08:29:29 +02:00
Unescape Escape
Table of Contents
This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

Using Type Checkers with PTB

Since Python 3.6, static type hinting is established in Python and PTB makes use of it (since v13.0). Static type checking helps to avoid and find errors both in PTBs source code and in your bot code. If you want to take advantage of this, you should use a type checker to check your code. As type checking in general is not PTB specific and a big topic, an introduction to type hinting is beyond the scope of this wiki.

ℹ️ Note

While static type hints are of great value and we try our best to make them as precise as possible, they usually don't have any implications on runtime behavior. It therefore may happen that some type hints are not perfect or outright wrong and we may change & fix them between minor versions without announcement. This may lead to your type checker reporting errors after an upgrade, but it won't introduce bugs into your code.

Please also note that type hinting in Python does not cover all edge cases, so there might be situations where PTB just can't do better.

Of course, you are always welcome to report any type hinting errors through the bug tracker.

Generic classes in PTB

Some of the classes in telegram.ext that may be subclassed by users are generic classes, i.e. subclasses of typing.Generic. When subclassing them, the type variables should be specified. These classes currently are telegram.ext.Handler, telegram.ext.BasePersistence and telegram.ext.CallbackContext. Please have a look at the respective documentation page for more info on the type variables that these classes accept.

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