Python-telegram-bot

==============
*Released 2022-06-27*

This is the technical changelog for version 20.0a2. More elaborate release notes can be found in the news channel `pythontelegrambotchannel <https://t.me/pythontelegrambotchannel>`_.

Major Changes
-------------

- Full Support for API 6.1 (:pr:`3112`)

New Features
------------

- Add Additional Shortcut Methods to ``Chat`` (:pr:`3115`)
- Mermaid-based Example State Diagrams (:pr:`3090`)

Minor Changes, Documentation Improvements and CI
------------------------------------------------

- Documentation Improvements (:pr:`3103`, :pr:`3121`, :pr:`3098`)
- Stabilize CI (:pr:`3119`)
- Bump ``pyupgrade`` from 2.32.1 to 2.34.0 (:pr:`3096`)
- Bump ``furo`` from 2022.6.4 to 2022.6.4.1 (:pr:`3095`)
- Bump ``mypy`` from 0.960 to 0.961 (:pr:`3093`)

==============
*Released 2022-06-09*

This is the technical changelog for version 20.0a1. More elaborate release notes can be found in the news channel `pythontelegrambotchannel <https://t.me/pythontelegrambotchannel>`_.

Major Changes:
--------------

- Drop Support for ``ujson`` and instead ``BaseRequest.parse_json_payload`` (:pr:`3037`, :pr:`3072`)
- Drop ``InputFile.is_image`` (:pr:`3053`)
- Drop Explicit Type conversions in ``__init__`` s (:pr:`3056`)
- Handle List-Valued Attributes More Consistently (:pr:`3057`)
- Split ``{Command, Prefix}Handler`` And Make Attributes Immutable (:pr:`3045`)
- Align Behavior Of ``JobQueue.run_daily`` With ``cron`` (:pr:`3046`)
- Make PTB Specific Keyword-Only Arguments for PTB Specific in Bot methods (:pr:`3035`)
- Adjust Equality Comparisons to Fit Bot API 6.0 (:pr:`3033`)
- Add Tuple Based Version Info (:pr:`3030`)
- Improve Type Annotations for ``CallbackContext`` and Move Default Type Alias to ``ContextTypes.DEFAULT_TYPE`` (:pr:`3017`, :pr:`3023`)
- Rename ``Job.context`` to ``Job.data`` (:pr:`3028`)
- Rename ``Handler`` to ``BaseHandler`` (:pr:`3019`)

New Features:
-------------

- Add ``Application.post_init`` (:pr:`3078`)
- Add Arguments ``chat/user_id`` to ``CallbackContext`` And Example On Custom Webhook Setups (:pr:`3059`)
- Add Convenience Property ``Message.id`` (:pr:`3077`)
- Add Example for ``WebApp`` (:pr:`3052`)
- Rename ``telegram.bot_api_version`` to ``telegram.__bot_api_version__`` (:pr:`3030`)

Bug Fixes:
----------

- Fix Non-Blocking Entry Point in ``ConversationHandler`` (:pr:`3068`)
- Escape Backslashes in ``escape_markdown`` (:pr:`3055`)

Dependencies:
-------------

- Update ``httpx`` requirement from ~=0.22.0 to ~=0.23.0 (:pr:`3069`)
- Update ``cachetools`` requirement from ~=5.0.0 to ~=5.2.0 (:pr:`3058`, :pr:`3080`)

Minor Changes, Documentation Improvements and CI:
-------------------------------------------------

- Move Examples To Documentation (:pr:`3089`)
- Documentation Improvements and Update Dependencies (:pr:`3010`, :pr:`3007`, :pr:`3012`, :pr:`3067`, :pr:`3081`, :pr:`3082`)
- Improve Some Unit Tests (:pr:`3026`)
- Update Code Quality dependencies (:pr:`3070`, :pr:`3032`,:pr:`2998`, :pr:`2999`)
- Don't Set Signal Handlers On Windows By Default (:pr:`3065`)
- Split ``{Command, Prefix}Handler`` And Make Attributes Immutable (:pr:`3045`)
- Apply ``isort`` and Update ``pre-commit.ci`` Configuration (:pr:`3049`)
- Adjust ``pre-commit`` Settings for ``isort`` (:pr:`3043`)
- Add Version Check to Examples (:pr:`3036`)
- Use ``Collection`` Instead of ``List`` and ``Tuple`` (:pr:`3025`)
- Remove Client-Side Parameter Validation (:pr:`3024`)
- Don't Pass Default Values of Optional Parameters to Telegram (:pr:`2978`)
- Stabilize ``Application.run_*`` on Python 3.7 (:pr:`3009`)
- Ignore Code Style Commits in ``git blame`` (:pr:`3003`)
- Adjust Tests to Changed API Behavior (:pr:`3002`)

==============
*Released 2022-05-06*

This is the technical changelog for version 20.0a0. More elaborate release notes can be found in the news channel `pythontelegrambotchannel <https://t.me/pythontelegrambotchannel>`_.

Major Changes:
--------------

- Refactor Initialization of Persistence Classes
(:pr:`2604`)
- Drop Non-``CallbackContext`` API
(:pr:`2617`)
- Remove ``__dict__`` from ``__slots__`` and drop Python 3.6
(:pr:`2619`,
:pr:`2636`)
- Move and Rename ``TelegramDecryptionError`` to
``telegram.error.PassportDecryptionError``
(:pr:`2621`)
- Make ``BasePersistence`` Methods Abstract
(:pr:`2624`)
- Remove ``day_is_strict`` argument of ``JobQueue.run_monthly``
(:pr:`2634`
by `iota-008 <https://github.com/iota-008>`__)
- Move ``Defaults`` to ``telegram.ext``
(:pr:`2648`)
- Remove Deprecated Functionality
(:pr:`2644`,
:pr:`2740`,
:pr:`2745`)
- Overhaul of Filters
(:pr:`2759`,
:pr:`2922`)
- Switch to ``asyncio`` and Refactor PTBs Architecture
(:pr:`2731`)
- Improve ``Job.__getattr__``
(:pr:`2832`)
- Remove ``telegram.ReplyMarkup``
(:pr:`2870`)
- Persistence of ``Bots``: Refactor Automatic Replacement and
Integration with ``TelegramObject``
(:pr:`2893`)

New Features:
-------------

- Introduce Builder Pattern
(:pr:`2646`)
- Add ``Filters.update.edited``
(:pr:`2705`
by `PhilippFr <https://github.com/PhilippFr>`__)
- Introduce ``Enums`` for ``telegram.constants``
(:pr:`2708`)
- Accept File Paths for ``private_key``
(:pr:`2724`)
- Associate ``Jobs`` with ``chat/user_id``
(:pr:`2731`)
- Convenience Functionality for ``ChatInviteLinks``
(:pr:`2782`)
- Add ``Dispatcher.add_handlers``
(:pr:`2823`)
- Improve Error Messages in ``CommandHandler.__init__``
(:pr:`2837`)
- ``Defaults.protect_content``
(:pr:`2840`)
- Add ``Dispatcher.migrate_chat_data``
(:pr:`2848`
by `DonalDuck004 <https://github.com/DonalDuck004>`__)
- Add Method ``drop_chat/user_data`` to ``Dispatcher`` and Persistence
(:pr:`2852`)
- Add methods ``ChatPermissions.{all, no}_permissions`` (:pr:`2948`)
- Full Support for API 6.0
(:pr:`2956`)
- Add Python 3.10 to Test Suite
(:pr:`2968`)

Bug Fixes & Minor Changes:
--------------------------

- Improve Type Hinting for ``CallbackContext``
(:pr:`2587`
by `revolter <https://github.com/revolter>`__)
- Fix Signatures and Improve ``test_official``
(:pr:`2643`)
- Refine ``Dispatcher.dispatch_error``
(:pr:`2660`)
- Make ``InlineQuery.answer`` Raise ``ValueError``
(:pr:`2675`)
- Improve Signature Inspection for Bot Methods
(:pr:`2686`)
- Introduce ``TelegramObject.set/get_bot``
(:pr:`2712`
by `zpavloudis <https://github.com/zpavloudis>`__)
- Improve Subscription of ``TelegramObject``
(:pr:`2719`
by `SimonDamberg <https://github.com/SimonDamberg>`__)
- Use Enums for Dynamic Types & Rename Two Attributes in ``ChatMember``
(:pr:`2817`)
- Return Plain Dicts from ``BasePersistence.get_*_data``
(:pr:`2873`)
- Fix a Bug in ``ChatMemberUpdated.difference``
(:pr:`2947`)
- Update Dependency Policy
(:pr:`2958`)

Internal Restructurings & Improvements:
---------------------------------------

- Add User Friendly Type Check For Init Of
``{Inline, Reply}KeyboardMarkup``
(:pr:`2657`)
- Warnings Overhaul
(:pr:`2662`)
- Clear Up Import Policy
(:pr:`2671`)
- Mark Internal Modules As Private
(:pr:`2687`
by `kencx <https://github.com/kencx>`__)
- Handle Filepaths via the ``pathlib`` Module
(:pr:`2688`
by `eldbud <https://github.com/eldbud>`__)
- Refactor MRO of ``InputMedia*`` and Some File-Like Classes
(:pr:`2717`
by `eldbud <https://github.com/eldbud>`__)
- Update Exceptions for Immutable Attributes
(:pr:`2749`)
- Refactor Warnings in ``ConversationHandler``
(:pr:`2755`,
:pr:`2784`)
- Use ``__all__`` Consistently
(:pr:`2805`)

CI, Code Quality & Test Suite Improvements:
-------------------------------------------

- Add Custom ``pytest`` Marker to Ease Development
(:pr:`2628`)
- Pass Failing Jobs to Error Handlers
(:pr:`2692`)
- Update Notification Workflows
(:pr:`2695`)
- Use Error Messages for ``pylint`` Instead of Codes
(:pr:`2700`
by `Piraty <https://github.com/Piraty>`__)
- Make Tests Agnostic of the CWD
(:pr:`2727`
by `eldbud <https://github.com/eldbud>`__)
- Update Code Quality Dependencies
(:pr:`2748`)
- Improve Code Quality
(:pr:`2783`)
- Update ``pre-commit`` Settings & Improve a Test
(:pr:`2796`)
- Improve Code Quality & Test Suite
(:pr:`2843`)
- Fix failing animation tests
(:pr:`2865`)
- Update and Expand Tests & pre-commit Settings and Improve Code
Quality
(:pr:`2925`)
- Extend Code Formatting With Black
(:pr:`2972`)
- Update Workflow Permissions
(:pr:`2984`)
- Adapt Tests to Changed ``Bot.get_file`` Behavior
(:pr:`2995`)

Documentation Improvements:
---------------------------

- Doc Fixes
(:pr:`2597`)
- Add Code Comment Guidelines to Contribution Guide
(:pr:`2612`)
- Add Cross-References to External Libraries & Other Documentation
Improvements
(:pr:`2693`,
:pr:`2691`
by `joesinghh <https://github.com/joesinghh>`__,
:pr:`2739`
by `eldbud <https://github.com/eldbud>`__)
- Use Furo Theme, Make Parameters Referenceable, Add Documentation
Building to CI, Improve Links to Source Code & Other Improvements
(:pr:`2856`,
:pr:`2798`,
:pr:`2854`,
:pr:`2841`)
- Documentation Fixes & Improvements
(:pr:`2822`)
- Replace ``git.io`` Links
(:pr:`2872`
by `murugu-21 <https://github.com/murugu-21>`__)
- Overhaul Readmes, Update RTD Startpage & Other Improvements
(:pr:`2969`)

=============
*Released 2022-02-02*

This is the technical changelog for version 13.11. More elaborate release notes can be found in the news channel `pythontelegrambotchannel <https://t.me/pythontelegrambotchannel>`_.

**Major Changes:**

- Full Support for Bot API 5.7 (:pr:`2881`)

=============
*Released 2022-01-03*

This is the technical changelog for version 13.10. More elaborate release notes can be found in the news channel `pythontelegrambotchannel <https://t.me/pythontelegrambotchannel>`_.

**Major Changes:**

- Full Support for API 5.6 (:pr:`2835`)

**Minor Changes & Doc fixes:**

- Update Copyright to 2022 (:pr:`2836`)
- Update Documentation of ``BotCommand`` (:pr:`2820`)

============
*Released 2021-12-11*

This is the technical changelog for version 13.9. More elaborate release notes can be found in the news channel `pythontelegrambotchannel <https://t.me/pythontelegrambotchannel>`_.

**Major Changes:**

- Full Support for Api 5.5 (:pr:`2809`)

**Minor Changes**

- Adjust Automated Locking of Inactive Issues (:pr:`2775`)