python-telegram-bot

We've just released v20.0b0. Thank you to everyone who contributed to this release. If you want to upgrade from v20.0a6 to v20.0b0, please upgrade with pip install -U --pre python-telegram-bot. Before upgrading from v13.x to v20.0b0, please carefully read the v20.0a0 release notes. This release is the first beta release. It contains the last breaking changes that we had on our roadmap for v20. We are not planning to introduce any more breaking changes before releasing v20.0. Instead, we will mainly give the beta release a short testing period and fix any bugs that might come up. Then it's time for a v20.0 release. For the legacy versions v13.x, this beta release means two things. Firstly, we are not going to backport API changes to v13.x anymore. Secondly, we will stop support for v13.x completely once the stable v20.0 release is there. The breaking change in this release is that TelegramObject and its subclasses are now immutable, i.e. attributes of Update, Message and all other Telegram classes can no longer be overridden or deleted. Moreover, all attributes and return values of bot methods that formerly where lists are now tuples. With these changes, the library better reflects that all the objects usually represent a fixed state on the Telegram servers that can only be changed by making a request to the Bot API. Please see below for the full changelog. Major Changes • Make TelegramObject Immutable (#3249) Minor Changes, Documentation Improvements and CI • Reduce Code Duplication in Testing Defaults (#3419) • Add Notes and Warnings About Optional Dependencies (#3393) • Simplify Internals of Bot Methods (#3396) • Reduce Code Duplication in Several Bot Methods (#3385) • Documentation Improvements (#3386, #3395, #3398, #3403 by Viicos) Dependencies • Bump pytest-xdist from 3.0.2 to 3.1.0 (#3415) • Bump pytest-asyncio from 0.20.2 to 0.20.3 (#3417) • pre-commit autoupdate (#3409)

We've just released v13.15. Thank you to everyone who contributed to this release. As usual, upgrade using pip install -U python-telegram-bot. Please note that we have recently published the pre-release v20.0a0 and the focus of our development efforts is directed at v20. Our plans for the future of v13 are explained in the v20.0a0 release notes. Major Changes: • Full Support for API 6.3 (#3392) Bug Fixes: • Fix Bugs in Bot.answer_web_app_query (#3364)

We've just released v20.0a6. Thank you to everyone who contributed to this release. If you want to upgrade from v20.0a5 to v20.0a6, please upgrade with pip install -U --pre python-telegram-bot. Before upgrading from v13.x to v20.0a6, please carefully read the v20.0a0 release notes. This is a bug fix release that addresses some issues of the previous release v20.0a5. In particular, the download methods of telegram.File are now actually named as originally announced. For the full list of changes and improvements, please see below. Bug Fixes • Only Persist Arbitrary callback_data if ExtBot.callback_data_cache is Present (#3384) • Improve Backwards Compatibility of TelegramObjects Pickle Behavior (#3382) • Fix Naming and Keyword Arguments of File.download_* Methods (#3380) • Fix Return Value Annotation of Chat.create_forum_topic (#3381)

We've just released v20.0a5. Thank you to everyone who contributed to this release. If you want to upgrade from v20.0a4 to v20.0a5, please upgrade with pip install -U --pre python-telegram-bot. Before upgrading from v13.x to v20.0a5, please carefully read the v20.0a0 release notes. This update brings full support for Bot API 6.3. It also brings new features and some breaking changes. The first breaking change is that the method File.download was split into the methods File.download_to_drive and File.download_to_memory. The second breaking change is only relevant for those who run their bot against a local Bot API server: You will now have to explicitly tell PTB that you're doing this, by using ApplicationBuilder().token(TOKEN).local_mode(True).build(). The upside of this change is that you can now pass file paths as input for e.g. send_document independetly of whether you're using a local API server or not. The final breaking change is another step in our effort to make PTB as free of third party dependencies as possible. In particular, now almost no third party dependencies are installed by default. To use features of the telegram.ext module that require these dependencies, you will have to install PTB e.g. via pip install python-telegram-bot[job-queue]. Please have a look at the readme for more information. A notable new feature is the new attribute api_kwargs of all Telegram classes, which allows to access newly added fields even before PTB adds support for new API versions. Moreover, the string representations of the Telegram classes was completely overhauled. Also, we're delighted to have two new developers in our team: clot27, @mr_lemontree, who have already contributed to this release! The full changelog has become rather long, so please find it here.

Hacktoberfest has ended and we're happy to report that several contributions were proposed by first-time contributors, most of which have already been merged. We want to sincerely thank everyone who participated in this event! Of course contributions are just as welcome outside of Hacktoberfest 🙃 Feel free to join us in the development group chat and we'll be happy to get you started.

It's time for Hacktoberfest again! 💻🥨 Hacktoberfest is an event that encourages developers and everyone else to contribute to open source repositories. If you ever thought about starting coding or giving back to your favourite open source repositories, now is the time! Head over to the hacktoberfest website to learn more about it. This is also a great opportunity to contribute to python-telegram-bot🙂 We have already prepared a few issues on our repositories, but feel free to begin a hunt for improvements and fixes by yourself! We'd like to especially point out issue #3109 and #3110, which are about improving our documentation. These issues can be tackled in multiple pull requests and are perfect for first time contributors. ⚠️ If you want to tackle an issue, please be sure to • leave a comment on the issue before you work on it, so that we can assign you. That way, we avoid duplicate pull requests for the same issue by several people. • read the contribution guide. For questions about making contributions to python-telegram-bot we also have a dedicated developer chat group, where you can get focused help if you run into problems while preparing your pull request.

We've just released v13.14. Thank you to everyone who contributed to this release. As usual, upgrade using pip install -U python-telegram-bot. Please note that we have recently published the pre-release v20.0a0 and the focus of our development efforts is directed at v20. Our plans for the future of v13 are explained in the v20.0a0 release notes. Major Changes: • Full Support for API 6.2 (#3203) Minor Changes: • Documentation Improvements (#3144, #3140 by javad94, #3164 by javad94) • Pin tornado to Version 6.1 (#3145)

We've just released v20.0a4. This is a hot fix release for a bug in setup.py that prevented optional dependencies from being recognized correctly. If you want to upgrade from v20.0a3 to v20.0a4, please upgrade with pip install -U --pre python-telegram-bot. Before upgrading from v13.x to v20.0a4, please carefully read the v20.0a0 release notes. • Fix a Bug in setup.py Regarding Optional Dependencies (#3209)

We've just released v20.0a3. Thank you to everyone who contributed to this release. If you want to upgrade from v20.0a2 to v20.0a3, please upgrade with pip install -U --pre python-telegram-bot. Before upgrading from v13.x to v20.0a3, please carefully read the v20.0a0 release notes. This update brings full support for Bot API 6.2. It also brings a brand-new mechanism for rate limiting API requests. This is a replacement for the former MessageQueue and is well-integrated into the PTB framework. Also check out our updated wiki page on this topic! Major Changes • Full Support for API 6.2 (#3195) New Features • New Rate Limiting Mechanism (#3148) • Make chat/user_data Available in Error Handler for Errors in Jobs (#3152) • Add Application.post_shutdown (#3126 by ExalFabu) Bug Fixes • Fix helpers.mention_markdown for Markdown V1 and Improve Related Unit Tests (#3155) • Add api_kwargs Parameter to Bot.log_out and Improve Related Unit Tests (#3147) • Make Bot.delete_my_commands a Coroutine Function (#3136) • Fix ConversationHandler.check_update not respecting per_user (#3128) Minor Changes, Documentation Improvements and CI • Add Python 3.11 to Test Suite & Adapt Enum Behaviour (#3168) • Drop Manual Token Validation (#3167) • Simplify Unit Tests for Bot.send_chat_action (#3151) • Drop pre-commit Dependencies from requirements-dev.txt (#3120) • Change Default Values for concurrent_updates and connection_pool_size (#3127) • Documentation Improvements (#3139, #3153 by pawanrai9999, #3135 by aditya-yadav-27) • Type Hinting Fixes (#3202) Dependencies • Bump sphinx from 5.0.2 to 5.1.1 (#3177) • Update pre-commit Dependencies (#3085) • Bump pytest-asyncio from 0.18.3 to 0.19.0 (#3158) • Update tornado requirement from ~=6.1 to ~=6.2 (#3149) • Bump black from 22.3.0 to 22.6.0 (#3132) • Bump actions/setup-python from 3 to 4 (#3131)

We've just released v13.13. Thank you to everyone who contributed to this release. To upgrade from v13.x to v13.13, use pip install -U python-telegram-bot. Please note that we have recently published the pre-release v20.0a0 and the focus of our development efforts is directed at v20. Our plans for the future of v13 are explained in the v20.0a0 release notes. Major Changes: • Full Support for API 6.1 (#3117)

We've just released v20.0a2. Thank you to everyone who contributed to this release. If you want to upgrade from v20.0a1 to v20.0a2, please upgrade with pip install -U --pre python-telegram-bot. Before upgrading from v13.x to v20.0a2, please carefully read the v20.0a0 release notes. This update brings full support for Bot API 6.1 along with some minor, non-breaking changes. Note that a backport of API 6.1 to v13.x will be released before the end of this week. For the full list of changes and improvements, please see below. Major Changes • Full Support for API 6.1 (#3112) New Features • Add Additional Shortcut Methods to Chat (#3115 by aditya-yadav-27) • Mermaid-based Example State Diagrams (#3090 by cyc8) Minor Changes, Documentation Improvements and CI • Documentation Improvements (#3103, #3121 by ExalFabu, #3098 by david-shiko) • Stabilize CI (#3119) • Bump pyupgrade from 2.32.1 to 2.34.0 (#3096) • Bump furo from 2022.6.4 to 2022.6.4.1 (#3095) • Bump mypy from 0.960 to 0.961 (#3093)

We've just released v20.0a1. Thank you to everyone who contributed to this release. If you want to upgrade from v20.0a0 to v20.0a1, please carefully read the notes below before upgrading with pip install -U --pre python-telegram-bot. Before upgrading from v13.x to v20.0a1, please carefully read the v20.0a0 release notes. This update brings a few breaking changes compared to v20.0a0, but none of them are as disruptive as the changes introduced in v20.0a0. Let us highlight a few of them: • CallbackContext.DEFAULT_TYPE was moved to ContextTypes.DEFAULT_TYPE. • Support for ujson was dropped. If you want to use a 3rd party JSON library, you can do so by using a custom implementation of BaseRequest. • The day argument of JobQueue.run_daily was changed to align with cron, i.e. 0 is now Sunday and 6 is Saturday • The context argument of JobQueue.run_* was renamed to data and similarly for Job.context - in hopes of avoiding confusion in the future. This release also brings some new features, including Application.post_init to effortlessly execute asyncio code on startup and version info in the style of sys.version_info. For the full list of changes and improvements, please see below. Major Changes: • Drop Support for ujson and instead BaseRequest.parse_json_payload (#3037, #3072) • Drop InputFile.is_image (#3053) • Drop Explicit Type conversions in __init__ s (#3056) • Handle List-Valued Attributes More Consistently (#3057) • Split {Command, Prefix}Handler And Make Attributes Immutable (#3045) • Align Behavior Of JobQueue.run_daily With cron (#3046 by jcnecio) • Make PTB Specific Keyword-Only Arguments for PTB Specific in Bot methods (#3035 by tal66) • Adjust Equality Comparisons to Fit Bot API 6.0 (#3033) • Add Tuple Based Version Info (#3030)- Improve Type Annotations for CallbackContext and Move Default Type Alias to ContextTypes.DEFAULT_TYPE (#3017, #3023) • Rename Job.context to Job.data (#3028 by aditya-yadav-27) • Rename Handler to BaseHandler (#3019) New Features: • Add Application.post_init (#3078) • Add Arguments chat/user_id to CallbackContext And Example On Custom Webhook Setups (#3059) • Add Convenience Property Message.id (#3077 by dglitxh) • Add Example for WebApp (#3052) • Rename telegram.bot_api_version to telegram.__bot_api_version__ (#3030) Bug Fixes: • Fix Non-Blocking Entry Point in ConversationHandler (#3068) • Escape Backslashes in escape_markdown (#3055) Dependencies: • Update httpx requirement from ~=0.22.0 to ~=0.23.0 (#3069) • Update cachetools requirement from ~=5.0.0 to ~=5.2.0 (#3058, #3080) Minor Changes, Documentation Improvements and CI: • Move Examples To Documentation (#3089) • Documentation Improvements and Update Dependencies (#3010, #3007 by KnorpelSenf, #3012, #3067 by Aditya-Rajgor, #3081, #3082) • Improve Some Unit Tests (#3026) • Update Code Quality dependencies (#3070, #3032,#2998, #2999) • Don't Set Signal Handlers On Windows By Default (#3065) • Split {Command, Prefix}Handler And Make Attributes Immutable (#3045) • Apply isort and Update pre-commit.ci Configuration (#3049) • Adjust pre-commit Settings for isort (#3043) • Add Version Check to Examples (#3036) • Use Collection Instead of List and Tuple (#3025) • Remove Client-Side Parameter Validation (#3024) • Don't Pass Default Values of Optional Parameters to Telegram (#2978) • Stabilize Application.run_* on Python 3.7 (#3009) • Ignore Code Style Commits in git blame (#3003) • Adjust Tests to Changed API Behavior (#3002)